Skip to content

Commit e930c17

Browse files
[chore/github]: Standardize GitHub PR description template
Replace legacy templates with unified pull_request_template.md (description, type, approach, documentation). Signed-off-by: Oleksandr Ivantsiv <oivantsiv@nvidia.com>
1 parent a3df22e commit e930c17

2 files changed

Lines changed: 40 additions & 18 deletions

File tree

.github/copilot-instructions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,10 @@ pytest tests/ --cov=sonic_platform_base --cov-report=term-missing
8383
- **Abstract methods**: New abstract methods must have default implementations to avoid breaking subclasses
8484
- **Documentation**: All new API methods need docstrings
8585
- **PR description template**: Fill out all sections of the [PR template](.github/pull_request_template.md) when submitting a pull request:
86-
- **Description**: Describe your changes in detail
87-
- **Motivation and Context**: Why is this change required? What problem does it solve? Reference issues with "fixes #xxxx"
88-
- **How Has This Been Tested?**: Describe how you tested your changes, including test environment and tests run
89-
- **Additional Information**: Any other relevant details (optional)
86+
- **Description of PR**: Summary of the change, motivation/context, reviewer entry point, and dependencies; reference issues with `fixes #xxxx` / `closes #xxxx`.
87+
- **Type of change**: Mark the box(es) that apply — bug fix, new feature, refactor / cleanup, documentation update, test improvement.
88+
- **Approach**: Motivation; how you did it; how you verified/tested it; any platform-specific notes.
89+
- **Documentation**: Link to wiki / doc updates relevant to new features or test cases.
9090

9191
## Common Patterns
9292

.github/pull_request_template.md

Lines changed: 36 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,45 @@
1-
<!-- Provide a general summary of your changes in the Title above -->
2-
3-
#### Description
41
<!--
5-
Describe your changes in detail
6-
-->
2+
Please make sure you've read and understood our contributing guidelines;
3+
https://github.com/Azure/SONiC/blob/gh-pages/CONTRIBUTING.md
74
8-
#### Motivation and Context
5+
Please provide following information to help code review process a bit easier:
6+
-->
7+
### Description of PR
98
<!--
10-
Why is this change required? What problem does it solve?
11-
If this pull request closes/resolves an open Issue, make sure you
12-
include the text "fixes #xxxx", "closes #xxxx" or "resolves #xxxx" here
9+
- Please include a summary of the change and which issue is fixed.
10+
- Please also include relevant motivation and context. Where should reviewer start? background context?
11+
- List any dependencies that are required for this change.
1312
-->
1413

15-
#### How Has This Been Tested?
14+
Summary:
15+
Fixes # (issue)
16+
17+
### Type of change
18+
1619
<!--
17-
Please describe in detail how you tested your changes.
18-
Include details of your testing environment, and the tests you ran to
19-
see how your change affects other areas of the code, etc.
20+
- Fill x for your type of change.
21+
- e.g.
22+
- [x] Bug fix
2023
-->
2124

22-
#### Additional Information (Optional)
25+
- [ ] Bug fix
26+
- [ ] New feature
27+
- [ ] Refactor / cleanup
28+
- [ ] Documentation update
29+
- [ ] Test improvement
30+
31+
### Approach
32+
#### What is the motivation for this PR?
2333

34+
#### How did you do it?
35+
36+
#### How did you verify/test it?
37+
38+
#### Any platform specific information?
39+
40+
### Documentation
41+
<!--
42+
(If it's a new feature, new test case)
43+
Did you update documentation/Wiki relevant to your implementation?
44+
Link to the wiki page?
45+
-->

0 commit comments

Comments
 (0)