From c327689992ffde5b7551c1d20a97fff21d346cc9 Mon Sep 17 00:00:00 2001
From: Joe LeVeque <jleveque@users.noreply.github.com>
Date: Wed, 10 Feb 2021 23:12:21 -0800
Subject: [PATCH] [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
---
 .github/ISSUE_TEMPLATE.md        | 60 --------------------------------
 .github/PULL_REQUEST_TEMPLATE.md | 40 ---------------------
 .github/issue_template.md        | 58 ++++++++++++++++++++++++++++++
 .github/pull_request_template.md | 41 ++++++++++++++++++++++
 4 files changed, 99 insertions(+), 100 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE.md
 delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md
 create mode 100644 .github/issue_template.md
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index 05f39760b1..0000000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -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)
-    ```
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
deleted file mode 100644
index 0d91878c95..0000000000
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ /dev/null
@@ -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)**
diff --git a/.github/issue_template.md b/.github/issue_template.md
new file mode 100644
index 0000000000..d460bdc31d
--- /dev/null
+++ b/.github/issue_template.md
@@ -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`
+-->
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000000..d2c06ae13a
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -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)
+