Skip to content

Commit e7b06d2

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 5734b26 commit e7b06d2

2 files changed

Lines changed: 38 additions & 20 deletions

File tree

.github/copilot-instructions.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,11 @@ def test_my_config_command():
112112
- **Testing**: All new commands MUST have unit tests
113113
- **Backwards compatibility**: Don't break existing CLI command syntax
114114
- **Yang validation**: New config commands should validate against YANG models
115+
- **PR description template**: Fill out all sections of the [PR template](.github/pull_request_template.md) when submitting a pull request:
116+
- **Description of PR**: Summary of the change, motivation/context, reviewer entry point, and dependencies; reference issues with `fixes #xxxx` / `closes #xxxx`.
117+
- **Type of change**: Mark the box(es) that apply — bug fix, new feature, refactor / cleanup, documentation update, test improvement.
118+
- **Approach**: Motivation; how you did it; how you verified/tested it; any platform-specific notes.
119+
- **Documentation**: Link to wiki / doc updates relevant to new features or test cases.
115120

116121
## Common Patterns
117122

.github/pull_request_template.md

Lines changed: 33 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,45 @@
11
<!--
2-
Please make sure you've read and understood our contributing guidelines:
3-
https://github.com/Azure/SONiC/blob/gh-pages/CONTRIBUTING.md
2+
Please make sure you've read and understood our contributing guidelines;
3+
https://github.com/Azure/SONiC/blob/gh-pages/CONTRIBUTING.md
44
5-
** Make sure all your commits include a signature generated with `git commit -s` **
6-
7-
If this is a bug fix, make sure your description includes "closes #xxxx",
8-
"fixes #xxxx" or "resolves #xxxx" so that GitHub automatically closes the related
9-
issue when the PR is merged.
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+
-->
1013

11-
If you are adding/modifying/removing any command or utility script, please also
12-
make sure to add/modify/remove any unit tests from the tests
13-
directory as appropriate.
14+
Summary:
15+
Fixes # (issue)
1416

15-
If you are modifying or removing an existing 'show', 'config' or 'sonic-clear'
16-
subcommand, or you are adding a new subcommand, please make sure you also
17-
update the Command Line Reference Guide (doc/Command-Reference.md) to reflect
18-
your changes.
17+
### Type of change
1918

20-
Please provide the following information:
19+
<!--
20+
- Fill x for your type of change.
21+
- e.g.
22+
- [x] Bug fix
2123
-->
2224

23-
#### What I did
25+
- [ ] Bug fix
26+
- [ ] New feature
27+
- [ ] Refactor / cleanup
28+
- [ ] Documentation update
29+
- [ ] Test improvement
2430

25-
#### How I did it
31+
### Approach
32+
#### What is the motivation for this PR?
2633

27-
#### How to verify it
34+
#### How did you do it?
2835

29-
#### Previous command output (if the output of a command-line utility has changed)
36+
#### How did you verify/test it?
3037

31-
#### New command output (if the output of a command-line utility has changed)
38+
#### Any platform specific information?
3239

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)