docs: update the pull request template (#446)

Co-authored-by: pyansys-ci-bot <[email protected]>
ansys · Nov 7, 2024 · df6ca0b · df6ca0b
1 parent 06cee16
commit df6ca0b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -1,4 +1,10 @@
-Checklist:
+## Description
+**Please provide a brief description of the changes made in this pull request.**
+
+## Issue linked
+**Please mention the issue number or describe the problem this pull request addresses.**
+
+## Checklist:
 - [] Run unit tests and make sure they all pass
 		- Run tests without Sherlock running
 		- Run tests with Sherlock GRPC connection
@@ -13,3 +19,4 @@ Checklist:
 		- Click on "API Reference" at the top.
 		- Verify HTML for API changes.
 - [] Check that test code coverage is at least 80% when Sherlock is running
+- [] Make sure that the title of the pull request follows [Commit naming conventions](https://dev.docs.pyansys.com/how-to/contributing.html#commit-naming-conventions) (e.g. ``feat: adding new PySherlock command``)
diff --git a/doc/changelog.d/446.documentation.md b/doc/changelog.d/446.documentation.md
@@ -0,0 +1 @@
+docs: update the pull request template