Skip to content

Commit

Permalink
🐝 Add commit message generation instructions for Copilot (#3745)
Browse files Browse the repository at this point in the history
* 🐝 Add commit message generation instructions for Copilot
  • Loading branch information
Marigold authored Dec 19, 2024
1 parent 7ae6528 commit 167c627
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
48 changes: 48 additions & 0 deletions .copilot-commit-message-instructions.md
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.
5 changes: 5 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,10 @@
"yaml.format.printWidth": 999,
"ruff.path": [
".venv/bin/ruff"
],
"github.copilot.chat.commitMessageGeneration.instructions": [
{
"file": ".copilot-commit-message-instructions.md"
}
]
}

0 comments on commit 167c627

Please sign in to comment.