Skip to content

Commit

Permalink
multiple templates, one for docs one for code
Browse files Browse the repository at this point in the history
  • Loading branch information
braindigitalis committed Sep 20, 2023
1 parent 1aae3ac commit 522be8b
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 3 deletions.
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/code_change_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[ Please outline your change here. Be sure to check the checkboxes below. ]

## Code change checklist

- [ ] I have ensured that all methods and functions are **fully documented** using doxygen style comments
- [ ] My code follows the [coding style guide](https://dpp.dev/coding-standards.html)
- [ ] I tested that my change works before raising the PR
- [ ] I have ensured that I did not break any existing API calls
- [ ] I have not built my pull request using AI, a static analysis tool or similar without any human oversight
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/docs_change_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[ Please outline your change here. Be sure to check the checkboxes below. ]

## Documentation change checklist

- [ ] My documentation changes follow the same style as the rest of the documentation and any examples follow the [coding style guide](https://dpp.dev/coding-standards.html)
- [ ] I have not moved any existing pages or changed any existing URLs without strong justification as to why
- [ ] I have not generated content using AI or a desktop utility such as grammarly.
6 changes: 3 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- [ ] I have ensured that all methods and functions are **fully documented** using doxygen style comments, and tested my code (including any documentation examples). Where neccessary a unit test was added
- [ ] My code follows the [coding style guide](https://dpp.dev/coding-standards.html)
- [ ] I have not built my pull request using AI, a static analysis tool or similar without any human oversight. Where I have generated this pull request using a tool, I have justified why this is needed.
Please go the the `Preview` tab and select the appropriate pull request template for your changes:

* [Code Changes](?expand=1&template=code_change_template.md)
* [Documentation Changes](?expand=1&template=docs_change_template.md)

0 comments on commit 522be8b

Please sign in to comment.