diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 4e8b96436cc..d4f991c5b9e 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -112,6 +112,11 @@ def test_my_config_command(): - **Testing**: All new commands MUST have unit tests - **Backwards compatibility**: Don't break existing CLI command syntax - **Yang validation**: New config commands should validate against YANG models +- **PR description template**: Fill out all sections of the [PR template](.github/pull_request_template.md) when submitting a pull request: + - **Description of PR**: Summary of the change, motivation/context, reviewer entry point, and dependencies; reference issues with `fixes #xxxx` / `closes #xxxx`. + - **Type of change**: Mark the box(es) that apply — bug fix, new feature, refactor / cleanup, documentation update, test improvement. + - **Approach**: Motivation; how you did it; how you verified/tested it; any platform-specific notes. + - **Documentation**: Link to wiki / doc updates relevant to new features or test cases. ## Common Patterns diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3b4edc9dd81..f9372611bef 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,32 +1,45 @@ +### Description of PR + - If you are adding/modifying/removing any command or utility script, please also - make sure to add/modify/remove any unit tests from the tests - directory as appropriate. +Summary: +Fixes # (issue) - If you are modifying or removing an existing 'show', 'config' or 'sonic-clear' - subcommand, or you are adding a new subcommand, please make sure you also - update the Command Line Reference Guide (doc/Command-Reference.md) to reflect - your changes. +### Type of change - Please provide the following information: + -#### What I did +- [ ] Bug fix +- [ ] New feature +- [ ] Refactor / cleanup +- [ ] Documentation update +- [ ] Test improvement -#### How I did it +### Approach +#### What is the motivation for this PR? -#### How to verify it +#### How did you do it? -#### Previous command output (if the output of a command-line utility has changed) +#### How did you verify/test it? -#### New command output (if the output of a command-line utility has changed) +#### Any platform specific information? +### Documentation +