Add the issue and pull request templates (#31)

* Add the issue and pull request templates * Add the Related issue section
0xAX · Jun 17, 2024 · 851c8f9 · 851c8f9
1 parent af64838
commit 851c8f9
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/.github/issue-template.md b/.github/issue-template.md
@@ -0,0 +1,9 @@
+<!-- Thank you for your contribution. Before you submit the issue:
+- Search open and closed issues for duplicates.
+- Read the [Contributing guidelines](../contributing.md).
+- Follow the [Code of Conduct](../CODE_OF_CONDUCT.md).
+-->
+
+**Description**
+
+<!-- In this section, provide a clear and concise description of the issue. Provide proper argumentation and screenshots, if necessary. -->
diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md
@@ -0,0 +1,18 @@
+<!-- Thank you for your contribution. When contributing to the project, remember to:
+- Read the [Contribution guide](../contributing.md).
+- Follow the [Code of Conduct](../CODE_OF_CONDUCT.md).
+-->
+
+**Description**
+
+<!-- In this section, provide a description of your changes. The context and justification let others understand your motivation and the purpose of the pull request. Follow the description with a list that summarises the most relevant changes included in the pull request. -->
+
+Changes proposed in this pull request:
+
+- ...
+- ...
+- ...
+
+**Related issues**
+
+<!-- Link the related issue here, if applicable. -->