Copilot instructions
.github/instructions/commit.instructions.mdCopilot instructions
Quality
58/100
Scores the file, not the repository.Length
337 words
11 headings · 2 code blocksRepository
3
— · pushed 221 days agoLast changed
2 days ago
First indexed 2 days ago.1# Commit Message Guidelines23Follow these rules for all commit messages to ensure clarity and consistency.45## Commit Message Format67```8<type>[optional scope]: <subject>9<BLANK LINE>10[optional body]11```1213- **type**: One of `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `perf`, `build`, `ci`, `chore`, `revert`14- **scope**: (Optional) A noun describing the section affected (e.g., `api`, `ui`, `auth`)15- **subject**: Short, imperative summary (max 50 characters, no period)16- **body**: (Optional) Detailed explanation, reasoning, or context1718## Examples1920```21feat(api): Add user login endpoint22fix(ui): Correct button alignment23docs(README): update usage section for clarity24style: format codebase using Prettier25refactor(auth): simplify token handling logic and improve error handling2627# Explanations:28# - Used lowercase for commit types/scopes for Conventional Commits consistency.29# - Made descriptions more specific and actionable.30# - Added "improve error handling" to encourage robust refactoring.31# - Used imperative mood for clarity and best practices.32test(api): Add tests for login33perf: Optimize query performance34build: Update dependencies35ci: Add GitHub Actions workflow36chore: Remove unused files37revert: Revert "feat(api): Add user login endpoint"38```3940## Best Practices41- Use imperative mood in the subject (e.g., "Add", not "Added" or "Adds")42- Start subject with a capital letter43- Do not end subject with a period44- Limit subject to 50 characters for readability45- Leave a blank line between subject and body46- Use the body for:47 - Explaining the motivation and context48 - Listing multiple changes as bullet points49 - Referencing related issues or PRs (e.g., "Closes #123")50- Ensure messages are descriptive and actionable51- For breaking changes, start the body with `BREAKING CHANGE:`52- Only mention files that are directly affected by the change5354## Error Handling & Edge Cases5556- If reverting a commit, use the `revert:` type and reference the original commit57- For multi-part changes, consider splitting into focused commits58- Avoid ambiguous types or scopes; be specific5960## Atomic Commits61- Each commit should represent a single logical change62- Avoid large commits that mix multiple changes63
Similar configs
Same format, overlapping stack, ranked by quality.
| Repository | Format | Stack | Covers | Score | Changed |
|---|---|---|---|---|---|
| chihebnabil/lovable-boilerplate.github/instructions/global.instructions.md · 63 | Copilot instructions | buildlint-formatstylearch+4 | 100/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.github/copilot-instructions.md · 17 | Copilot instructions | setupbuildtestlint-format+7 | 100/100 | 3 days ago | |
| louislam/uptime-kuma.github/copilot-instructions.md · 90k | Copilot instructions | setupbuildtestlint-format+9 | 100/100 | 3 days ago | |
| JCodesMore/ai-website-cloner-template.github/copilot-instructions.md · 31k | Copilot instructions | buildlint-formatstylearch+3 | 97/100 | 2 days ago | |
| bagisto/bagisto.github/copilot-instructions.md · 28k | Copilot instructions | setupbuildteststyle+5 | 97/100 | 3 days ago | |
| darkmatter/nixmac.github/copilot-instructions.md · 24 | Copilot instructions | setupbuildtestlint-format+8 | 96/100 | 3 days ago | |
| nerolis-lab/nerolis-lab.github/copilot-instructions.md · 32 | Copilot instructions | setupbuildtestlint-format+11 | 96/100 | 3 days ago | |
| thangaram611/second-brain.github/copilot-instructions.md · 0 | Copilot instructions | setupteststylearch+4 | 96/100 | 3 days ago |
