docs(docs-infra): update commit message guidelines #311
Conversation
This file contains hidden or 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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the commit message guidelines in CONTRIBUTING.md to align with Angular's conventions, providing more detailed formatting rules and practical examples for contributors. The changes enhance clarity around commit message structure and add comprehensive scoping guidelines.
Key changes:
- Updated reference from generic conventional commits to Angular's specific commit message guidelines
- Added detailed formatting rules with character limits and visual formatting guide
- Expanded commit message examples with better structure and more comprehensive scope definitions
| [optional footer(s)] | ||
| ``` | ||
|
|
||
| The header(`<type>(<scope>): <description>`) is mandatory and the scope of the header is optional. |
There was a problem hiding this comment.
Missing space after 'header' before the opening parenthesis. Should be 'The header (<type>(<scope>): <description>) is mandatory and the scope of the header is optional.'
Suggested change
| The header(`<type>(<scope>): <description>`) is mandatory and the scope of the header is optional. | |
| The header (`<type>(<scope>): <description>`) is mandatory and the scope of the header is optional. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
This pull request updates the commit message guidelines in the
CONTRIBUTING.mdfile to align with Angular's conventions and provides clearer instructions and examples for contributors. The main improvements are more detailed formatting rules and practical commit message samples.