tomevault-io What I do
- Create commit messages based on conventional commits
- Commit message with "type(scope): description" format
- Suggests additional details for the commit body if needed
- Encourages single responsibility in commits
- Split to multiple commits if necessary following best practices and Single Responsibility Principle
- Commit Message Format:
- Use clear and concise commit messages.
- Follow the format:
<type>(<scope>): <subject><type>: chore, feat, fix, docs, style, refactor, test, perf, ci<scope>: optional, specify the area of the codebase affected<subject>: brief description of the change
- Example:
feat(auth): add OAuth2 support
- Descriptive Messages:
- Provide detailed descriptions in the commit body if necessary.
- Single Responsibility:
- Each commit only focuses on a single change or feature.
- Avoid bundling unrelated changes in one commit.
- Example: Instead of
fix and update UI, use two separate commits:fix(button): correct button alignmentandfeat(ui): update color scheme.
- Testing:
- Ensure all tests pass before committing changes if applicable.
- Linting:
- Run linting tools to maintain code quality.
When to use me
Use this when you are about to make a commit and want to ensure it follows conventional commit standards, and a brief description of the change.
Converted and distributed by TomeVault — claim your Tome and manage your conversions.