-
-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🐝 Add commit message generation instructions for Copilot (#3745)
* 🐝 Add commit message generation instructions for Copilot
- Loading branch information
Showing
2 changed files
with
53 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
## Commit Message Instructions | ||
|
||
Start your commit message with a **category emoji** from the list below to describe the purpose of the change. | ||
|
||
Format: `<emoji>: <message>` | ||
|
||
Examples: | ||
✨ Add new search functionality | ||
🐛 Fix crash when uploading files | ||
|
||
### Categories | ||
|
||
- 📊 **Data**: Updates or adds data. | ||
Example: `📊 Update population dataset` | ||
|
||
- 🐛 **Bug**: Fixes a user-facing bug. | ||
Example: `🐛 Fix broken link in footer` | ||
|
||
- 🔨 **Refactor**: Changes code without fixing bugs or adding features. | ||
Example: `🔨 Refactor chart rendering logic` | ||
|
||
- ✨ **Enhance**: Improves existing functionality. | ||
Example: `✨ Improve chart loading speed` | ||
|
||
- 🎉 **Feature**: Adds a new user-facing feature. | ||
Example: `🎉 Add dark mode support` | ||
|
||
- 📜 **Docs**: Updates or adds documentation. | ||
Example: `📜 Add setup guide for developers` | ||
|
||
- 🧹 **Chore**: Maintenance tasks like dependency updates. | ||
Example: `🧹 Update Node.js to latest version` | ||
|
||
- 💄 **Style**: Formatting or linting changes. | ||
Example: `💄 Fix inconsistent indentation` | ||
|
||
- 🚧 **WIP**: Work in progress for future commits. | ||
Example: `🚧 Add initial layout for dashboard` | ||
|
||
- ✅ **Tests**: Adds or refactors tests. | ||
Example: `✅ Add missing unit tests` | ||
|
||
--- | ||
|
||
### Tips | ||
- Keep messages concise and clear. | ||
- Use one emoji per commit for clarity. | ||
- Split changes into separate commits if needed. |
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