chore: add a template for pull request descriptions (#213)

eclipse-tractusx · Apr 14, 2023 · eaa504c · eaa504c
1 parent c43febe
commit eaa504c
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,13 @@
+## WHAT
+
+_Briefly describe what your PR changes, which features it adds/modifies._
+
+## WHY
+
+_Briefly state why the change was necessary._
+
+## FURTHER NOTES
+
+_List other areas of code that have changed but are not necessarily linked to the main feature. This could be method signature changes, package declarations, bugs that were encountered and were fixed inline, etc._
+
+Closes # <-- _insert Issue number if one exists_
diff --git a/.github/workflows/verify.yaml b/.github/workflows/verify.yaml
@@ -84,7 +84,7 @@ jobs:
 
       - name: Run markdownlint
         run: |
-          markdownlint-cli2-config .markdownlint.yaml "**/*.md"
+          markdownlint-cli2-config .markdownlint.yaml "**/*.md" "#.github"
 
   unit-tests:
     runs-on: ubuntu-latest