-
Notifications
You must be signed in to change notification settings - Fork 678
Open
Description
It would be helpful to add an option that ensures commit messages follow the Conventional Commits specification. This provides a consistent commit format that improves readability, automation, and changelog generation.
What are Conventional Commits?
Conventional Commits define a structured format for commit messages:
<type>(<scope>): <description>
- type — The category of change
- scope (optional) — The part of the codebase affected
- description — A short summary of the change
Common types
Examples of commonly used commit types:
feat— A new featurefix— A bug fixdocs— Documentation changesstyle— Formatting or stylistic changes (no code behavior changes)refactor— Code restructuring without changing behaviortest— Adding or updating testschore— Maintenance tasks (dependencies, tooling, etc.)
Scopes
Scopes allow specifying the area of the project affected by the change. This helps make commit history easier to understand in larger projects.
Examples:
feat(auth): add OAuth login support
fix(api): handle null response in user endpoint
docs(readme): update installation instructions
refactor(parser): simplify token handling
Scopes are optional but recommended when changes affect a specific module or component.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels