YogliB/copilot_commit_instructions.md

Last active October 29, 2025 09:43

Star (0) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/YogliB/c8e0c7a2d43aa8c32cf8a48dc27dc1e5.js"></script>
Save YogliB/c8e0c7a2d43aa8c32cf8a48dc27dc1e5 to your computer and use it in GitHub Desktop.

Download ZIP

Raw

copilot_commit_instructions.md

Conventional Commit Message Guidelines

Format

<JIRA_TICKET_ID>: type(scope) description

Recommended Length

Title (header): ≤ 72 characters
Keep the message short, concise and clear.

Types

feat: A new feature
fix: A bug fix
docs: Documentation only changes
style: Code style changes (formatting, no logic)
refactor: Code change that neither fixes a bug nor adds a feature
perf: Performance improvement
test: Adding or updating tests
chore: Maintenance tasks (build, tooling, dependencies)

Rules

Prefix every commit with the JIRA ticket ID, e.g., CP-1234:.
Use lowercase for type and scope.
Keep the description short and imperative, no period at the end.
Scope is mandatory (e.g., ui, api).

Examples

CP-1234: feat(auth) add JWT authentication
CP-2345: fix(api) handle null values in response
CP-3456: docs(readme) update installation instructions
CP-4567: refactor(core) simplify data parsing logic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment