docs(CONTRIBUTING): Improve the commit message documentation #1159
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
mnonnenmacher
requested review from
bs-ondem,
MarcelBochtler,
nnobelis,
oheger-bosch and
sschuberth
as code owners
sschuberth
reviewed
Oct 4, 2024
There was a problem hiding this comment.
As we just had the discussion, should we also add that links to issues should be done in the commit, not in the PR?
Add more details about the conventional commit types, the handling of breaking changes, and the versioning of the project. Fixes #319. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
mnonnenmacher
force-pushed
the
improve-contributing
branch
from
b72ec7d to
081922d
Compare
sschuberth
approved these changes
Oct 4, 2024
mmurto
reviewed
Oct 5, 2024
| For example, use "Add feature" instead of "Added feature". | ||
| #### Breaking changes | ||
|
|
||
| Breaking changes should be indicated by either adding a `BREAKING CHANGE:` section to the commit message body or by adding a `!` after the type, for example: |
There was a problem hiding this comment.
We probably should communicate what is considered a breaking change, so is the REST API only thing we consider for versioning. Also, if we plan to do API versioning (/api/v1/ etc.) what exactly is a breaking change if we strictly follow that?
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.
Add more details about the conventional commit types, the handling of breaking changes, and the versioning of the project.
Fixes #319.