docs: convential commits spec #1405
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
WalkthroughThe Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
convential_commits.md (1)
1-10: Consider enhancing the rationale section with examples.While the guidelines are clear, adding examples would make them more actionable:
- Show how semantic versioning ties into conventional commits (e.g.,
feat!: breaking change in API)- Include examples of good PR titles that follow the convention
- Semantic versioning is **mandatory** for Pull Requests, particularly the use of `!` for breaking changes. +- Semantic versioning is **mandatory** for Pull Requests, particularly the use of `!` for breaking changes. For example: + - `feat(api)!: remove deprecated endpoints` + - `fix: resolve memory leak in worker pool` + - `docs: update installation guide`
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
convential_commits.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: startup-functional-test (3.12)
- GitHub Check: startup-docker-compose-test
- GitHub Check: migrations-check (3.12)
- GitHub Check: enterprise-startup-functional-test (3.12)
- GitHub Check: functional-tests (3.12, chromium)
- GitHub Check: enterprise-startup-docker-compose-test
- GitHub Check: enterprise-functional-tests (3.12, chromium)
- GitHub Check: Analyze (python)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
convential_commits.md (1)
1-23: Well-structured conventional commits documentation!The document provides clear guidelines and rationale for adopting conventional commits. The balance between mandatory and recommended practices is pragmatic and should help with adoption.
Comment on lines
+11
to
+23
| ## Convention | ||
|
|
||
| - Use lowercase for all commit messages. | ||
| - Include a scope when relevant. For example, use `feat(lib)` when adding a new framework or library. | ||
| - The following commit types are supported: | ||
| - `fix`: Bug fixes | ||
| - `feat`: New features | ||
| - `chore`: Maintenance tasks or changes that don't affect production code | ||
| - `refactor`: Code changes that neither fix bugs nor add features | ||
| - `docs`: Documentation updates or improvements | ||
| - `test`: Adding or updating tests | ||
| - `ci`: Changes to the CI configuration or scripts | ||
| - `build`: Changes that affect the build system or external dependencies |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance convention details with additional guidelines.
Consider adding these important aspects of conventional commits:
- Guidelines for commit message body and footer
- Breaking change footer format (
BREAKING CHANGE: description) - Multi-line commit message format
- Common scope examples for your project
- Include a scope when relevant. For example, use `feat(lib)` when adding a new framework or library.
+- Include a scope when relevant. Common scopes include:
+ - `api`: API-related changes
+ - `ui`: User interface changes
+ - `db`: Database changes
+ - `lib`: Library or dependency changes
+
+- Commit message format:
+ ```
+ <type>[optional scope]: <description>
+
+ [optional body]
+
+ [optional footer(s)]
+ ```
+
+- For breaking changes, include a footer:
+ ```
+ BREAKING CHANGE: <description>
+ ```
- The following commit types are supported:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ## Convention | |
| - Use lowercase for all commit messages. | |
| - Include a scope when relevant. For example, use `feat(lib)` when adding a new framework or library. | |
| - The following commit types are supported: | |
| - `fix`: Bug fixes | |
| - `feat`: New features | |
| - `chore`: Maintenance tasks or changes that don't affect production code | |
| - `refactor`: Code changes that neither fix bugs nor add features | |
| - `docs`: Documentation updates or improvements | |
| - `test`: Adding or updating tests | |
| - `ci`: Changes to the CI configuration or scripts | |
| - `build`: Changes that affect the build system or external dependencies | |
| ## Convention | |
| - Use lowercase for all commit messages. | |
| - Include a scope when relevant. Common scopes include: | |
| - `api`: API-related changes | |
| - `ui`: User interface changes | |
| - `db`: Database changes | |
| - `lib`: Library or dependency changes | |
| - Commit message format: |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
will cover and fix #1334
Summary by CodeRabbit
conventional_commits.mdwith comprehensive guidelines for commit message standards