diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 2ceca52..429793b 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -3,7 +3,9 @@ ## Code Style & Formatting Standards ### Commit Messages (Conventional Commits) + Use the following prefixes for all commits: + - `feat:` New features - `fix:` Bug fixes - `docs:` Documentation changes @@ -18,7 +20,9 @@ Use the following prefixes for all commits: Example: `feat: Add ETA automation with timezone awareness` ### PR Titles (Emoji Prefix) + Use emoji prefix followed by brief description: + - `✨ Add new feature` - `🐛 Fix bug or issue` - `📚 Update documentation` @@ -31,25 +35,33 @@ Use emoji prefix followed by brief description: Example: `✨ Add interactive task selection with rich UI` ### PR Body (GitHub-Flavored Markdown) + Structure all PR descriptions with these sections: + ```markdown ### What does this PR do? + Brief explanation of changes and what was implemented. ### Why are we doing this? + Context, motivation, and reason for the changes. ### How should this be tested? + Testing instructions, test cases, and validation steps. ### Any deployment notes? + Environment variables, migrations, breaking changes, or special instructions. ``` Include related issue references: `Closes #71, #77` (at end of description) ### PR Metadata Requirements + Always ensure the following metadata is set on every PR: + - **Labels**: Assign relevant labels (e.g., `enhancement`, `bug`, `documentation`, `refactor`, `testing`) - **Assignees**: Assign to yourself (J-MaFf) - **Issues**: Link all related issues in the PR description and GitHub's linked issues feature @@ -75,14 +87,17 @@ Note: Use `gh issue edit` for both issues and pull requests. Replace `