[GitHub] Tweak PR and issue templates (#6744)
Tweak GitHub issue and pull request templates - Rename files to align with new [standard](https://docs.github.com/en/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests) - Use markdown headings rather than bolded bullets
This commit is contained in:
Joe LeVeque
GitHub
parent
a24235bd26
commit
c327689992
60
.github/ISSUE_TEMPLATE.md
vendored
60
.github/ISSUE_TEMPLATE.md
vendored
@ -1,60 +0,0 @@
|
|||||||
<!--
|
|
||||||
If you are reporting a new issue, make sure that we do not have any duplicates
|
|
||||||
already open. You can ensure this by searching the issue list for this
|
|
||||||
repository. If there is a duplicate, please close your issue and add a comment
|
|
||||||
to the existing issue instead.
|
|
||||||
|
|
||||||
If you suspect your issue is a bug, please edit your issue description to
|
|
||||||
include the BUG REPORT INFORMATION shown below. If you fail to provide this
|
|
||||||
information within 7 days, we cannot debug your issue and will close it. We
|
|
||||||
will, however, reopen it if you later provide the information.
|
|
||||||
|
|
||||||
For more information about reporting issues, see
|
|
||||||
https://github.com/Azure/SONiC/wiki#report-issues
|
|
||||||
|
|
||||||
---------------------------------------------------
|
|
||||||
GENERAL SUPPORT INFORMATION
|
|
||||||
---------------------------------------------------
|
|
||||||
|
|
||||||
The GitHub issue tracker is for bug reports and feature requests.
|
|
||||||
General support can be found at the following locations:
|
|
||||||
|
|
||||||
- SONiC Support Forums - https://groups.google.com/forum/#!forum/sonicproject
|
|
||||||
|
|
||||||
---------------------------------------------------
|
|
||||||
BUG REPORT INFORMATION
|
|
||||||
---------------------------------------------------
|
|
||||||
Use the commands below to provide key information from your environment:
|
|
||||||
You do NOT have to include this information if this is a FEATURE REQUEST
|
|
||||||
-->
|
|
||||||
|
|
||||||
**Description**
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Briefly describe the problem you are having in a few paragraphs.
|
|
||||||
-->
|
|
||||||
|
|
||||||
**Steps to reproduce the issue:**
|
|
||||||
1.
|
|
||||||
2.
|
|
||||||
3.
|
|
||||||
|
|
||||||
**Describe the results you received:**
|
|
||||||
|
|
||||||
|
|
||||||
**Describe the results you expected:**
|
|
||||||
|
|
||||||
|
|
||||||
**Additional information you deem important (e.g. issue happens only occasionally):**
|
|
||||||
|
|
||||||
**Output of `show version`:**
|
|
||||||
|
|
||||||
```
|
|
||||||
(paste your output here)
|
|
||||||
```
|
|
||||||
|
|
||||||
**Attach debug file `sudo generate_dump`:**
|
|
||||||
|
|
||||||
```
|
|
||||||
(paste your output here)
|
|
||||||
```
|
|
||||||
40
.github/PULL_REQUEST_TEMPLATE.md
vendored
40
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,40 +0,0 @@
|
|||||||
<!--
|
|
||||||
Please make sure you've read and understood our contributing guidelines:
|
|
||||||
https://github.com/Azure/SONiC/blob/gh-pages/CONTRIBUTING.md
|
|
||||||
|
|
||||||
** Make sure all your commits include a signature generated with `git commit -s` **
|
|
||||||
|
|
||||||
If this is a bug fix, make sure your description includes "fixes #xxxx", or
|
|
||||||
"closes #xxxx" or "resolves #xxxx"
|
|
||||||
|
|
||||||
Please provide the following information:
|
|
||||||
-->
|
|
||||||
|
|
||||||
**- Why I did it**
|
|
||||||
|
|
||||||
**- How I did it**
|
|
||||||
|
|
||||||
**- How to verify it**
|
|
||||||
|
|
||||||
**- Which release branch to backport (provide reason below if selected)**
|
|
||||||
|
|
||||||
<!--
|
|
||||||
- Note we only backport fixes to a release branch, *not* features!
|
|
||||||
- Please also provide a reason for the backporting below.
|
|
||||||
- e.g.
|
|
||||||
- [x] 202006
|
|
||||||
-->
|
|
||||||
|
|
||||||
- [ ] 201811
|
|
||||||
- [ ] 201911
|
|
||||||
- [ ] 202006
|
|
||||||
- [ ] 202012
|
|
||||||
|
|
||||||
**- Description for the changelog**
|
|
||||||
<!--
|
|
||||||
Write a short (one line) summary that describes the changes in this
|
|
||||||
pull request for inclusion in the changelog:
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
||||||
**- A picture of a cute animal (not mandatory but encouraged)**
|
|
||||||
58
.github/issue_template.md
vendored
Normal file
58
.github/issue_template.md
vendored
Normal file
@ -0,0 +1,58 @@
|
|||||||
|
<!--
|
||||||
|
If you are reporting a new issue, make sure that we do not have any duplicates
|
||||||
|
already open. You can ensure this by searching the issue list for this
|
||||||
|
repository. If there is a duplicate, please close your issue and add a comment
|
||||||
|
to the existing issue instead.
|
||||||
|
|
||||||
|
If you suspect your issue is a bug, please edit your issue description to
|
||||||
|
include the BUG REPORT INFORMATION shown below. If you fail to provide this
|
||||||
|
information within 7 days, we cannot debug your issue and will close it. We
|
||||||
|
will, however, reopen it if you later provide the information.
|
||||||
|
|
||||||
|
For more information about reporting issues, see
|
||||||
|
https://github.com/Azure/SONiC/wiki#report-issues
|
||||||
|
|
||||||
|
---------------------------------------------------
|
||||||
|
GENERAL SUPPORT INFORMATION
|
||||||
|
---------------------------------------------------
|
||||||
|
|
||||||
|
The GitHub issue tracker is for bug reports and feature requests.
|
||||||
|
General support can be found at the following locations:
|
||||||
|
|
||||||
|
- SONiC Support Forums - https://groups.google.com/forum/#!forum/sonicproject
|
||||||
|
|
||||||
|
---------------------------------------------------
|
||||||
|
BUG REPORT INFORMATION
|
||||||
|
---------------------------------------------------
|
||||||
|
Use the commands below to provide key information from your environment:
|
||||||
|
You do NOT have to include this information if this is a FEATURE REQUEST
|
||||||
|
-->
|
||||||
|
|
||||||
|
#### Description
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Briefly describe the problem you are having in a few paragraphs.
|
||||||
|
-->
|
||||||
|
|
||||||
|
#### Steps to reproduce the issue:
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
|
||||||
|
#### Describe the results you received:
|
||||||
|
|
||||||
|
|
||||||
|
#### Describe the results you expected:
|
||||||
|
|
||||||
|
|
||||||
|
#### Output of `show version`:
|
||||||
|
|
||||||
|
```
|
||||||
|
(paste your output here)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Additional information you deem important (e.g. issue happens only occasionally):
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Also attach debug file produced by `sudo generate_dump`
|
||||||
|
-->
|
||||||
41
.github/pull_request_template.md
vendored
Normal file
41
.github/pull_request_template.md
vendored
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
<!--
|
||||||
|
Please make sure you've read and understood our contributing guidelines:
|
||||||
|
https://github.com/Azure/SONiC/blob/gh-pages/CONTRIBUTING.md
|
||||||
|
|
||||||
|
** Make sure all your commits include a signature generated with `git commit -s` **
|
||||||
|
|
||||||
|
If this is a bug fix, make sure your description includes "fixes #xxxx", or
|
||||||
|
"closes #xxxx" or "resolves #xxxx"
|
||||||
|
|
||||||
|
Please provide the following information:
|
||||||
|
-->
|
||||||
|
|
||||||
|
#### Why I did it
|
||||||
|
|
||||||
|
#### How I did it
|
||||||
|
|
||||||
|
#### How to verify it
|
||||||
|
|
||||||
|
#### Which release branch to backport (provide reason below if selected)
|
||||||
|
|
||||||
|
<!--
|
||||||
|
- Note we only backport fixes to a release branch, *not* features!
|
||||||
|
- Please also provide a reason for the backporting below.
|
||||||
|
- e.g.
|
||||||
|
- [x] 202006
|
||||||
|
-->
|
||||||
|
|
||||||
|
- [ ] 201811
|
||||||
|
- [ ] 201911
|
||||||
|
- [ ] 202006
|
||||||
|
- [ ] 202012
|
||||||
|
|
||||||
|
#### Description for the changelog
|
||||||
|
<!--
|
||||||
|
Write a short (one line) summary that describes the changes in this
|
||||||
|
pull request for inclusion in the changelog:
|
||||||
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
#### A picture of a cute animal (not mandatory but encouraged)
|
||||||
|
|
||||||
Reference in New Issue
Block a user