Skip to content

Commit c077717

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 e0f95f6 commit c077717

2 files changed

Lines changed: 50 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,11 @@ Kernel patches are accepted under these conditions:
7676
- **Upstream first**: Prefer upstream patches — include the original commit hash
7777
- **Justification**: Explain why a patch is needed and why it can't be done out-of-tree
7878
- **CI**: Azure pipeline checks must pass
79+
- **PR description template**: Fill out all sections of the [PR template](.github/pull_request_template.md) when submitting a pull request:
80+
- **Description of PR**: Summary of the change, motivation/context, reviewer entry point, and dependencies; reference issues with `fixes #xxxx` / `closes #xxxx`.
81+
- **Type of change**: Mark the box(es) that apply — bug fix, new feature, refactor / cleanup, documentation update, test improvement.
82+
- **Approach**: Motivation; how you did it; how you verified/tested it; any platform-specific notes.
83+
- **Documentation**: Link to wiki / doc updates relevant to new features or test cases.
7984

8085
## Gotchas
8186

.github/pull_request_template.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<!--
2+
Please make sure you've read and understood our contributing guidelines;
3+
https://github.com/Azure/SONiC/blob/gh-pages/CONTRIBUTING.md
4+
5+
Please provide following information to help code review process a bit easier:
6+
-->
7+
### Description of PR
8+
<!--
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.
12+
-->
13+
14+
Summary:
15+
Fixes # (issue)
16+
17+
### Type of change
18+
19+
<!--
20+
- Fill x for your type of change.
21+
- e.g.
22+
- [x] Bug fix
23+
-->
24+
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?
33+
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)