Skip to content

Commit ac9720f

Browse files
authored
[GitHub] Tweak PR and issue templates (sonic-net#1419)
Tweak GitHub issue and pull request templates - Rename files to align with new standard - Use markdown headings rather than bolded bullets
1 parent 78968a1 commit ac9720f

File tree

4 files changed

+92
-92
lines changed

4 files changed

+92
-92
lines changed

.github/ISSUE_TEMPLATE.md

-60
This file was deleted.

.github/PULL_REQUEST_TEMPLATE.md

-32
This file was deleted.

.github/issue_template.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<!--
2+
If you are reporting a new issue, make sure that we do not have any duplicates
3+
already open. You can ensure this by searching the issue list for this
4+
repository. If there is a duplicate, please close your issue and add a comment
5+
to the existing issue instead.
6+
7+
If you suspect your issue is a bug, please edit your issue description to
8+
include the BUG REPORT INFORMATION shown below. If you fail to provide this
9+
information within 7 days, we cannot debug your issue and will close it. We
10+
will, however, reopen it if you later provide the information.
11+
12+
For more information about reporting issues, see
13+
https://github.com/Azure/SONiC/wiki#report-issues
14+
15+
---------------------------------------------------
16+
GENERAL SUPPORT INFORMATION
17+
---------------------------------------------------
18+
19+
The GitHub issue tracker is for bug reports and feature requests.
20+
General support can be found at the following locations:
21+
22+
- SONiC Support Forums - https://groups.google.com/forum/#!forum/sonicproject
23+
24+
---------------------------------------------------
25+
BUG REPORT INFORMATION
26+
---------------------------------------------------
27+
Use the commands below to provide key information from your environment:
28+
You do NOT have to include this information if this is a FEATURE REQUEST
29+
-->
30+
31+
#### Description
32+
33+
<!--
34+
Briefly describe the problem you are having in a few paragraphs.
35+
-->
36+
37+
## Steps to reproduce the issue
38+
1.
39+
2.
40+
3.
41+
42+
#### Describe the results you received
43+
44+
45+
#### Describe the results you expected
46+
47+
48+
#### Additional information you deem important (e.g. issue happens only occasionally)
49+
50+
51+
#### Output of `show version`
52+
53+
```
54+
(paste your output here)
55+
```
56+
57+
<!--
58+
Also attach debug file produced by `sudo generate_dump`
59+
-->
60+

.github/pull_request_template.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
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+
** 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.
10+
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+
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.
19+
20+
Please provide the following information:
21+
-->
22+
23+
#### What I did
24+
25+
#### How I did it
26+
27+
#### How to verify it
28+
29+
#### Previous command output (if the output of a command-line utility has changed)
30+
31+
#### New command output (if the output of a command-line utility has changed)
32+

0 commit comments

Comments
 (0)