Chore: document conventional commits #4188
Merged
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
drewbo
force-pushed
the
chore-document-conventional-commits-2230
branch
2 times, most recently
from
cf3f769
to
663a99a
Compare
|
Note that the only "truly new" portion of this PR is the bottom section of the new DEVELOPMENT.md document |
drewbo
force-pushed
the
chore-document-conventional-commits-2230
branch
2 times, most recently
from
cf3f769
to
ed39709
Compare
svenaas
reviewed
Jul 13, 2023
DEVELOPMENT.md
Outdated
|
|
||
| ## Commits, Releases, and Deployment | ||
|
|
||
| All commit messages on the default branch should follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. In addition, an associated ticket number should be added where relevant. Examples: |
There was a problem hiding this comment.
It's not that unusual for one of our commits to need to reference a ticket on one of our other GitHub repos. Should this perhaps clarify what those should look like?
There was a problem hiding this comment.
For example, the runbook I just did was a ticket on this repo, but the implementation was a commit to a different repo.
svenaas
requested changes
Jul 13, 2023
DEVELOPMENT.md
Outdated
|
|
||
| If you didn't follow this convention while making your commits locally or on a development, you'll still have (at least) two opportunities to edit the commit history to match the Convention Commits specification: | ||
| - while the code is on a non-default branch, you can perform an [interative rebase](https://git-scm.com/docs/git-rebase) to rewrite the history. | ||
| - prior to merging a PR, you can select either "Squash and merge" or "Rebase and merge" which will change the commit message(s) in the PR. |
There was a problem hiding this comment.
It is confusing that both of these are characterized as merges whereas merge commits on the feature branch are not allowed. This isn't particularly friendly, but I'm not sure how to make it better.
drewbo
force-pushed
the
chore-document-conventional-commits-2230
branch
4 times, most recently
from
3822624
to
97f96f4
Compare
drewbo
force-pushed
the
chore-document-conventional-commits-2230
branch
from
97f96f4
to
95fc76a
Compare
drewbo
force-pushed
the
chore-document-conventional-commits-2230
branch
from
82fdd4e
to
14147e1
Compare
apburnes
approved these changes
Jul 17, 2023
svenaas
approved these changes
Jul 18, 2023
Merged
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 proposed in this pull request:
security considerations
None