DRAFT: doc: update commit message guideline in Contributing page #265 #266
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
A little cleaner explanation on prefix and level association
Reviewer's Guide by SourceryThe PR updates the Contributing guidelines to provide a clearer and more structured explanation of the conventional commits system. The changes focus on improving readability and organization of the commit message guidelines, particularly around version level associations (MAJOR, MINOR, PATCH) and commit types. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @sun-mota - I've reviewed your changes - here's some feedback:
Overall Comments:
- The documentation for MAJOR version releases needs correction. Any commit type can trigger a MAJOR version when accompanied by a BREAKING CHANGE footer - it's not limited to or required to use the 'perf:' prefix. Please update this to avoid confusion.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
sun-mota
changed the title
blackfalcon
reviewed
Oct 31, 2024
Comment on lines
+99
to
+101
| Clean your room | ||
| Close the door | ||
| Take out the trash |
There was a problem hiding this comment.
Removing the - turns this into a single string
Clean your room Close the door Take out the trash A properly formed Git commit subject line should always be able to complete the following sentence:
Suggested change
| Clean your room | |
| Close the door | |
| Take out the trash | |
| - Clean your room | |
| - Close the door | |
| - Take out the trash | |
jason-capsule42
requested changes
Nov 13, 2024
| For a MAJOR release, you MUST follow this template. The use of `perf:` and `BREAKING CHANGE:` are needed in order to push a major release. | ||
| To trigger a **MAJOR** version update, use the following structure: | ||
|
|
||
| - **Prefix with `perf:`** |
There was a problem hiding this comment.
This prefix is not strictly required. The commit must preface with either perf, fix or feat
| | Type | Description | Version Level | | ||
| |------------------|---------------------------------------------------------------------------------------------------------------|---------------| | ||
| | `perf` | Code change that improves performance | MAJOR | | ||
| | **`BREAKING CHANGE`** | Non-backward compatible change (must be in the body, not in title) | MAJOR | |
There was a problem hiding this comment.
this isn't actually a commit type that you preface a commit with.
Comment on lines
+88
to
+89
| | `refactor` | Code change that neither fixes a bug nor adds a feature | PATCH | | ||
| | `style` | Code changes that don't affect logic (whitespace, formatting, etc.) | PATCH | |
There was a problem hiding this comment.
Suggested change
| | `refactor` | Code change that neither fixes a bug nor adds a feature | PATCH | | |
| | `style` | Code changes that don't affect logic (whitespace, formatting, etc.) | PATCH | | |
| | `refactor` | Code change(s) that neither fixes a bug nor adds a feature | PATCH | | |
| | `style` | Code change(s) that don't affect logic (whitespace, formatting, etc.) | PATCH | |
| | `fix` | Bug fixes | PATCH | | ||
| | `refactor` | Code change that neither fixes a bug nor adds a feature | PATCH | | ||
| | `style` | Code changes that don't affect logic (whitespace, formatting, etc.) | PATCH | | ||
| | `test` | Adds or corrects tests | PATCH | |
There was a problem hiding this comment.
Suggested change
| | `test` | Adds or corrects tests | PATCH | | |
| | `test` | Adds or corrects test(s) | PATCH | |
|
|
||
| Imperative mood simply means _“spoken or written as if giving a command or instruction”_. A few examples are: | ||
| Once you have completed your feature update, please commit all changes to the branch. All commit messages should use an imperative mood. |
There was a problem hiding this comment.
Suggested change
| Once you have completed your feature update, please commit all changes to the branch. All commit messages should use an imperative mood. | |
| Once you have completed your code change, commit all changes to a development branch. All commit messages should use an imperative mood. |
Comment on lines
+99
to
+101
| Clean your room | ||
| Close the door | ||
| Take out the trash |
There was a problem hiding this comment.
These should start lower case
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.
Alaska Airlines Pull Request
Fixes: #265
Summary:
A little cleaner explanation on prefix and level association
Type of change:
Please delete options that are not relevant.
Checklist:
By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.
Thank you for your submission!
-- Auro Design System Team
Summary by Sourcery
Documentation: