diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0cabf5653..000000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,24 +0,0 @@ - - -**- What I did** - -**- How I did it** - -**- How to verify it** - -**- Description for the changelog** - - diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 6ec261719..ebb0c92df 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -76,6 +76,11 @@ pytest tests/ --cov=sonic_ax_impl --cov-report=term-missing - **CLA**: Sign Linux Foundation EasyCLA - **RFC compliance**: MIB implementations must strictly follow the relevant RFC - **Testing**: Include tests with mock DB data for all new MIB objects +- **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 new file mode 100644 index 000000000..f9372611b --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,45 @@ + +### Description of PR + + +Summary: +Fixes # (issue) + +### Type of change + + + +- [ ] Bug fix +- [ ] New feature +- [ ] Refactor / cleanup +- [ ] Documentation update +- [ ] Test improvement + +### Approach +#### What is the motivation for this PR? + +#### How did you do it? + +#### How did you verify/test it? + +#### Any platform specific information? + +### Documentation +