chore: Minor changes to contributing doc and pr template for conventional commits #12439
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
commits. Signed-off-by: Callum Styan <[email protected]>
JStickler
approved these changes
Apr 2, 2024
CONTRIBUTING.md
Outdated
| 1. Your PR documents upgrading steps under `docs/sources/setup/upgrade/_index.md` if it changes: | ||
| 1. It starts with an imperative verb. Example: Fix the latency between System A and System B. | ||
| 2. It uses Sentence case, not Title Case. | ||
| 3. It has a clear description saying what it does and why. Your PR description will be present in the project' commit log, so be gentle to it. |
There was a problem hiding this comment.
Assuming that random apostrophe was meant to be a possessive?
Suggested change
| 3. It has a clear description saying what it does and why. Your PR description will be present in the project' commit log, so be gentle to it. | |
| 3. It has a clear description saying what it does and why. Your PR description will be present in the project's commit log, so be gentle to it. |
CONTRIBUTING.md
Outdated
| 1. It starts with an imperative verb. Example: Fix the latency between System A and System B. | ||
| 2. It uses Sentence case, not Title Case. | ||
| 3. It has a clear description saying what it does and why. Your PR description will be present in the project' commit log, so be gentle to it. | ||
| 2. Your PR is well sync'ed with main |
There was a problem hiding this comment.
Suggested change
| 2. Your PR is well sync'ed with main | |
| 2. Your PR is well synched with main |
trevorwhitney
approved these changes
Apr 2, 2024
| @@ -9,8 +9,7 @@ Fixes #<issue number> | |||
| - [ ] Reviewed the [`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md) guide (**required**) | |||
| - [ ] Documentation added | |||
| - [ ] Tests updated | |||
| - [ ] `CHANGELOG.md` updated | |||
| - [ ] If the change is worth mentioning in the release notes, add `add-to-release-notes` label | |||
There was a problem hiding this comment.
why don't we remove the action that was updating the release notes with this PR as well?
There was a problem hiding this comment.
done, I also added a note that we need to update the docs about updating the release notes as well, I'm not sure what changes we need to make there at the moment
github-actions
bot
added
the
type/docs
Signed-off-by: Callum Styan <[email protected]>
rhnasc
pushed a commit
to inloco/loki
that referenced
this pull request
Apr 12, 2024
…onal commits (grafana#12439) Signed-off-by: Callum Styan <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes based on the fact that we're now using conventional commits, we no longer want contributors making changes to the changelog themselves + we should include the link to conventional commits doc in the PR template.