ci: Add PR title check #5548
Merged
ci: Add PR title check #5548
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
rohan-bes
changed the title
rohan-bes
changed the title
rohan-bes
changed the title
rohan-bes
changed the title
rohan-bes
changed the title
jaskfla
approved these changes
Apr 2, 2024
README.md
Outdated
| @@ -163,3 +163,46 @@ In order to automatically format code in VS Code according to our style guide: | |||
| 2. Enable the **Editor: Format on Save** setting: `"editor.formatOnSave": true`. | |||
|
|
|||
| Your files will now be formatted automatically when you save them. | |||
|
|
|||
| ### PR title rules | |||
There was a problem hiding this comment.
Does this addition belong in the CONTRIBUTING.md instead?
We also have a (public!) Slab doc: https://beyond-essential.slab.com/posts/pr-titles-conventional-commits-avgsj3xb
There was a problem hiding this comment.
Ah good point, will move it there
README.md
Outdated
|
|
||
| We use a squash-and-merge strategy when merging PRs into dev. This means the commit messages in dev will match the PR titles. We like to keep standardised commit messages as an easy way to track release changes and for record keeping purposes. | ||
|
|
||
| The title of pull requests must be in [Conventional Commit] format. This is used to generate |
There was a problem hiding this comment.
Suggested change
| The title of pull requests must be in [Conventional Commit] format. This is used to generate | |
| The title of pull requests must be in [Conventional Commit](https://beyond-essential.slab.com/posts/pr-titles-conventional-commits-avgsj3xb) format. This is used to generate |
README.md
Outdated
|
|
||
| The title of pull requests must be in [Conventional Commit] format. This is used to generate | ||
| changelogs, and to provide a consistent format for commits landing in the main branch, as pull | ||
| requests are merged in "squash" mode. |
There was a problem hiding this comment.
Suggested change
| requests are merged in "squash" mode. | |
| requests are merged in “squash” mode. |
Admittedly a nitpick of nitpicks
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.
No description provided.