1- # 📝 Commit Message Guidelines
1+ # Commit Message Guidelines
22
33This project follows the [ Conventional Commits] ( https://www.conventionalcommits.org/ ) specification for consistent, readable commit messages.
44
5- ## 📋 Format
5+ ## Format
66
77```
88<type>(scope): <description>
@@ -12,7 +12,7 @@ This project follows the [Conventional Commits](https://www.conventionalcommits.
1212[optional footer]
1313```
1414
15- ## 🏷️ Commit Types
15+ ## Commit Types
1616
1717| Type | Purpose | Example |
1818| ------| ---------| ---------|
@@ -27,29 +27,29 @@ This project follows the [Conventional Commits](https://www.conventionalcommits.
2727| ` build ` | Build system changes | ` build: update webpack configuration ` |
2828| ` ci ` | CI/CD changes | ` ci: add automated testing workflow ` |
2929
30- ## 📏 Rules
30+ ## Rules
3131
32- ### ✅ DO
32+ ### DO
3333- ** Start with letter** after colon (upper/lowercase both OK): ` feat(cli): add new feature ` or ` feat(api): API integration `
3434- ** Be descriptive** : What you changed and why
3535- ** Keep subject line ≤100 characters total**
3636- ** Use imperative mood** : "add" not "added" or "adds"
3737- ** Include scope** when possible: ` feat(config): ... `
3838
39- ### ❌ DON'T
39+ ### DON'T
4040- Start with numbers or symbols after colon: ~~ ` feat(cli): 3 new features ` ~~
4141- Add trailing period: ~~ ` feat(cli): add new feature. ` ~~
4242- Be too vague: ~~ ` fix bug ` ~~ or ~~ ` update code ` ~~
4343- Exceed 100 characters in subject line (entire line)
4444- Use past tense: ~~ ` fixed bug ` ~~ (use ` fix bug ` )
4545
46- ### 🔀 Special Case: Merge Commits
46+ ### Special Case: Merge Commits
4747Merge commits generated by Git are automatically valid and don't need to follow conventional commit format:
4848- ` Merge branch 'feature/awesome' into main `
4949- ` Merge pull request #123 from user/branch `
5050- ` Merge remote-tracking branch 'origin/main' `
5151
52- ## 🎯 Writing Great Commit Messages
52+ ## Writing Great Commit Messages
5353
5454### Focus on WHAT and WHY, not HOW
5555
@@ -72,7 +72,7 @@ Added some changes # Not descriptive
7272WIP: working on feature # Not a complete change
7373```
7474
75- ## 🔧 FUSION-Specific Scopes
75+ ## FUSION-Specific Scopes
7676
7777Use these scopes to match the project architecture:
7878
@@ -89,7 +89,7 @@ Use these scopes to match the project architecture:
8989- ` unity ` - HPC integration (` fusion/unity/ ` )
9090- ` test ` - Testing framework (` tests/ ` )
9191
92- ## 🚀 Examples for Common Scenarios
92+ ## Examples for Common Scenarios
9393
9494### New Features
9595```
@@ -157,7 +157,7 @@ resource cleanup and reduces memory usage by 60% for large networks.
157157Fixes #234
158158```
159159
160- ## 🧪 Testing Your Commit Messages
160+ ## Testing Your Commit Messages
161161
162162Before committing, test your message format:
163163
@@ -167,15 +167,15 @@ Before committing, test your message format:
167167# Total subject line length: ≤100 characters
168168```
169169
170- ## 🔍 Why These Standards?
170+ ## Why These Standards?
171171
1721721 . ** Consistency** : All commits follow the same format
1731732 . ** Automation** : Tools can parse commit types for changelogs
1741743 . ** Clarity** : Clear what changed and where
1751754 . ** History** : Easy to understand project evolution
1761765 . ** Reviews** : Faster PR reviews with structured information
177177
178- ## 🛠️ Tools
178+ ## Tools
179179
180180Consider using:
181181- [ Conventional Commits CLI] ( https://github.com/conventional-commits/cli )
@@ -184,4 +184,4 @@ Consider using:
184184
185185---
186186
187- ** Remember** : Great commit messages help future you and your teammates understand the codebase evolution! 🎯
187+ ** Remember** : Great commit messages help future you and your teammates understand the codebase evolution!
0 commit comments