Skip to content

copilot.instructions.md

Latest commit

 

History

History
54 lines (43 loc) · 1.79 KB

copilot.instructions.md

File metadata and controls

54 lines (43 loc) · 1.79 KB
applyTo **

Clean Commit Workflow

This repository follows the Clean Commit workflow for all commit messages.

Reference: https://github.com/wgtechlabs/clean-commit

Commit Message Format

<emoji> <type>: <description>
<emoji> <type> (<scope>): <description>
<emoji> <type>!: <description>
<emoji> <type>! (<scope>): <description>

The 9 Types

Emoji Type What it covers
📦 new Adding new features, files, or capabilities
🔧 update Changing existing code, refactoring, improvements
🗑️ remove Removing code, files, features, or dependencies
🔒 security Security fixes, patches, vulnerability resolutions
⚙️ setup Project configs, CI/CD, tooling, build systems
☕ chore Maintenance tasks, dependency updates, housekeeping
🧪 test Adding, updating, or fixing tests
📖 docs Documentation changes and updates
🚀 release Version releases and release preparation

Rules

  • Use lowercase for type
  • Use ! immediately after type (no space) to signal a breaking change — only for new, update, remove, security
  • Use present tense ("add" not "added")
  • No period at the end
  • Keep description under 72 characters

Examples

  • 📦 new: user authentication system
  • 🔧 update (api): improve error handling
  • 🗑️ remove (deps): unused lodash dependency
  • 🔒 security: patch XSS vulnerability
  • ⚙️ setup: add eslint configuration
  • ☕ chore: update npm dependencies
  • 🧪 test: add unit tests for auth service
  • 📖 docs: update installation instructions
  • 🚀 release: version 1.0.0
  • 📦 new!: completely redesign authentication system
  • 🔧 update! (api): change response format for all endpoints