diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 62b36c23a..9e69ad659 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -108,6 +108,11 @@ go tool cover -html=coverage.out - **Go formatting**: Code MUST pass `gofmt` - **Proto changes**: Update generated code when modifying `.proto` files - **Security**: gNMI server handles authentication — be security-conscious +- **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 d3fb20679..f9372611b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,84 +1,45 @@ - -#### Why I did it - -#### How I did it - -#### How to verify it - -#### Which release branch to backport (provide reason below if selected) - +### Description of PR -- [ ] 202305 -- [ ] 202311 -- [ ] 202405 -- [ ] 202411 -- [ ] 202505 -- [ ] 202511 -- [ ] 202605 - -Tracking issue/work item for backport/cherry-pick request (GitHub issue or Microsoft ADO): -Failure type: +Summary: +Fixes # (issue) -#### Tested branch +### Type of change -- [ ] master -- [ ] 202305 -- [ ] 202311 -- [ ] 202405 -- [ ] 202411 -- [ ] 202505 -- [ ] 202511 -- [ ] 202605 -- [ ] N/A +- [ ] Bug fix +- [ ] New feature +- [ ] Refactor / cleanup +- [ ] Documentation update +- [ ] Test improvement -#### Test result +### Approach +#### What is the motivation for this PR? - +#### How did you do it? -#### Description for the changelog - +#### How did you verify/test it? + +#### Any platform specific information? -#### Link to config_db schema for YANG module changes +### Documentation - -#### A picture of a cute animal (not mandatory but encouraged) -