Skip to content

Commit e9cd36c

Browse files
authored
Merge pull request #324 from cipherstash/remove-commit-emojis
docs: simplify commit command documentation
2 parents 73c35df + c2f4219 commit e9cd36c

File tree

1 file changed

+41
-93
lines changed

1 file changed

+41
-93
lines changed

.claude/commands/commit.md

Lines changed: 41 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -30,81 +30,29 @@ Or with options:
3030
- **Verify before committing**: Ensure code is linted, builds correctly, and documentation is updated
3131
- **Atomic commits**: Each commit should contain related changes that serve a single purpose
3232
- **Split large changes**: If changes touch multiple concerns, split them into separate commits
33-
- **Conventional commit format**: Use the format `<type>: <description>` where type is one of:
33+
- **Present tense, imperative mood**: Write commit messages as commands (e.g., "add feature" not "added feature")
34+
- **Concise first line**: Keep the first line under 72 characters
35+
36+
The commit message should be structured as follows:
37+
38+
```
39+
<type>[optional scope]: <description>
40+
[optional body]
41+
```
42+
43+
Where `type` is one of:
3444
- `feat`: A new feature
3545
- `fix`: A bug fix
3646
- `docs`: Documentation changes
47+
- `deps`: Dependency changes (crate versions, etc)
3748
- `style`: Code style changes (formatting, etc)
3849
- `refactor`: Code changes that neither fix bugs nor add features
3950
- `perf`: Performance improvements
4051
- `test`: Adding or fixing tests
4152
- `chore`: Changes to the build process, tools, etc.
42-
- **Present tense, imperative mood**: Write commit messages as commands (e.g., "add feature" not "added feature")
43-
- **Concise first line**: Keep the first line under 72 characters
44-
- **Emoji**: Each commit type is paired with an appropriate emoji:
45-
- `feat`: ✨ New feature
46-
- `fix`: 🐛 Bug fix
47-
- `docs`: 📝 Documentation
48-
- `style`: 💄 Formatting/style
49-
- `refactor`: ♻️ Code refactoring
50-
- `perf`: ⚡️ Performance improvements
51-
- `test`: ✅ Tests
52-
- `chore`: 🔧 Tooling, configuration
53-
- `ci`: 🚀 CI/CD improvements
54-
- `revert`: 🗑️ Reverting changes
55-
- `test`: 🧪 Add a failing test
56-
- `fix`: 🚨 Fix compiler/linter warnings
57-
- `fix`: 🔒️ Fix security issues
58-
- `chore`: 👥 Add or update contributors
59-
- `refactor`: 🚚 Move or rename resources
60-
- `refactor`: 🏗️ Make architectural changes
61-
- `chore`: 🔀 Merge branches
62-
- `chore`: 📦️ Add or update compiled files or packages
63-
- `chore`: ➕ Add a dependency
64-
- `chore`: ➖ Remove a dependency
65-
- `chore`: 🌱 Add or update seed files
66-
- `chore`: 🧑‍💻 Improve developer experience
67-
- `feat`: 🧵 Add or update code related to multithreading or concurrency
68-
- `feat`: 🔍️ Improve SEO
69-
- `feat`: 🏷️ Add or update types
70-
- `feat`: 💬 Add or update text and literals
71-
- `feat`: 🌐 Internationalization and localization
72-
- `feat`: 👔 Add or update business logic
73-
- `feat`: 📱 Work on responsive design
74-
- `feat`: 🚸 Improve user experience / usability
75-
- `fix`: 🩹 Simple fix for a non-critical issue
76-
- `fix`: 🥅 Catch errors
77-
- `fix`: 👽️ Update code due to external API changes
78-
- `fix`: 🔥 Remove code or files
79-
- `style`: 🎨 Improve structure/format of the code
80-
- `fix`: 🚑️ Critical hotfix
81-
- `chore`: 🎉 Begin a project
82-
- `chore`: 🔖 Release/Version tags
83-
- `wip`: 🚧 Work in progress
84-
- `fix`: 💚 Fix CI build
85-
- `chore`: 📌 Pin dependencies to specific versions
86-
- `ci`: 👷 Add or update CI build system
87-
- `feat`: 📈 Add or update analytics or tracking code
88-
- `fix`: ✏️ Fix typos
89-
- `revert`: ⏪️ Revert changes
90-
- `chore`: 📄 Add or update license
91-
- `feat`: 💥 Introduce breaking changes
92-
- `assets`: 🍱 Add or update assets
93-
- `feat`: ♿️ Improve accessibility
94-
- `docs`: 💡 Add or update comments in source code
95-
- `db`: 🗃️ Perform database related changes
96-
- `feat`: 🔊 Add or update logs
97-
- `fix`: 🔇 Remove logs
98-
- `test`: 🤡 Mock things
99-
- `feat`: 🥚 Add or update an easter egg
100-
- `chore`: 🙈 Add or update .gitignore file
101-
- `test`: 📸 Add or update snapshots
102-
- `experiment`: ⚗️ Perform experiments
103-
- `feat`: 🚩 Add, update, or remove feature flags
104-
- `ui`: 💫 Add or update animations and transitions
105-
- `refactor`: ⚰️ Remove dead code
106-
- `feat`: 🦺 Add or update code related to validation
107-
- `feat`: ✈️ Improve offline support
53+
54+
A `scope` MAY be provided after a type. A scope consist of a noun describing a section of the codebase surrounded by parenthesis `fix(parser)`.
55+
10856

10957
## Guidelines for Splitting Commits
11058

@@ -119,40 +67,40 @@ When analyzing the diff, consider splitting commits based on these criteria:
11967
## Examples
12068

12169
Good commit messages:
122-
- feat: add user authentication system
123-
- fix: 🐛 resolve memory leak in rendering process
124-
- docs: 📝 update API documentation with new endpoints
125-
- refactor: ♻️ simplify error handling logic in parser
126-
- fix: 🚨 resolve linter warnings in component files
127-
- chore: 🧑‍💻 improve developer tooling setup process
128-
- feat: 👔 implement business logic for transaction validation
129-
- fix: 🩹 address minor styling inconsistency in header
130-
- fix: 🚑️ patch critical security vulnerability in auth flow
131-
- style: 🎨 reorganize component structure for better readability
132-
- fix: 🔥 remove deprecated legacy code
133-
- feat: 🦺 add input validation for user registration form
134-
- fix: 💚 resolve failing CI pipeline tests
135-
- feat: 📈 implement analytics tracking for user engagement
136-
- fix: 🔒️ strengthen authentication password requirements
137-
- feat: ♿️ improve form accessibility for screen readers
70+
- feat: add user authentication system
71+
- fix: resolve memory leak in rendering process
72+
- docs: update API documentation with new endpoints
73+
- refactor: simplify error handling logic in parser
74+
- fix: resolve linter warnings in component files
75+
- chore: improve developer tooling setup process
76+
- feat: implement business logic for transaction validation
77+
- fix: address minor styling inconsistency in header
78+
- fix: patch critical security vulnerability in auth flow
79+
- style: reorganize component structure for better readability
80+
- fix: remove deprecated legacy code
81+
- feat: add input validation for user registration form
82+
- fix: resolve failing CI pipeline tests
83+
- feat: implement analytics tracking for user engagement
84+
- fix: strengthen authentication password requirements
85+
- feat: improve form accessibility for screen readers
13886

13987
Example of splitting commits:
140-
- First commit: feat: add new solc version type definitions
141-
- Second commit: 📝 docs: update documentation for new solc versions
142-
- Third commit: 🔧 chore: update package.json dependencies
143-
- Fourth commit: 🏷️ feat: add type definitions for new API endpoints
144-
- Fifth commit: 🧵 feat: improve concurrency handling in worker threads
145-
- Sixth commit: 🚨 fix: resolve linting issues in new code
146-
- Seventh commit: test: add unit tests for new solc version features
147-
- Eighth commit: 🔒️ fix: update dependencies with security vulnerabilities
88+
- First commit: feat: add new solc version type definitions
89+
- Second commit: docs: update documentation for new solc versions
90+
- Third commit: chore: update package.json dependencies
91+
- Fourth commit: feat: add type definitions for new API endpoints
92+
- Fifth commit: feat: improve concurrency handling in worker threads
93+
- Sixth commit: fix: resolve linting issues in new code
94+
- Seventh commit: test: add unit tests for new solc version features
95+
- Eighth commit: fix: update dependencies with security vulnerabilities
14896

14997
## Command Options
15098

151-
- `--no-verify`: Skip running the pre-commit checks (`cargo check`, `cargo clippy`, `cargo fmt --check`)
99+
- `--no-verify`: Skip running the pre-commit checks
152100

153101
## Important Notes
154102

155-
- By default, pre-commit checks (`cargo check`, `cargo clippy`, `cargo fmt --check`) will run to ensure code quality
103+
- By default, pre-commit checks (`mise run check`) will run to ensure code quality
156104
- If these checks fail, you'll be asked if you want to proceed with the commit anyway or fix the issues first
157105
- If specific files are already staged, the command will only commit those files
158106
- If no files are staged, it will automatically stage all modified and new files

0 commit comments

Comments
 (0)