Merge pull request #255 from KOLANICH/pr_template_fixes

Improve PR and issue templates
secure-systems-lab · Sep 28, 2020 · 94d83b9 · 94d83b9
2 parents fb3b11a + 2e1ba21
commit 94d83b9
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,7 +1,5 @@
-Please fill in the fields below to submit an issue or feature request.  The
-more information that is provided, the better.
-
-
+<!-- Please fill in the fields below to submit an issue or feature request.  The
+more information that is provided, the better. -->
 **Description of issue or feature request**:
 
 

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,12 +1,14 @@
-Please fill in the fields below to submit a pull request.  The more information
-that is provided, the better.
+<!-- Please fill in the fields below to submit a pull request.  The more information
+that is provided, the better. -->
 
-**Fixes issue #**:
+<!-- Insert issue number here. See https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword for more info. -->
+Fixes: #
 
-**Description of the changes being introduced by the pull request**:
+### Description of the changes being introduced by the pull request:
 
-**Please verify and check that the pull request fulfils the following
-requirements**:
+
+
+### Please verify and check that the pull request fulfils the following requirements:
 
 - [ ] The code follows the [Code Style Guidelines](https://github.com/secure-systems-lab/code-style-guidelines#code-style-guidelines)
 - [ ] Tests have been added for the bug fix or new feature