From c3e448b34893fa391c8c76574e20b0c6b406e5fc Mon Sep 17 00:00:00 2001 From: Conor McCarthy Date: Fri, 17 Nov 2023 10:39:03 +0000 Subject: [PATCH] Update to include doc template --- .github/PULL_REQUEST_TEMPLATE/documentation.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/documentation.md diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation.md b/.github/PULL_REQUEST_TEMPLATE/documentation.md new file mode 100644 index 0000000..9fe5d99 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/documentation.md @@ -0,0 +1,11 @@ +# Documentation template + +## What does this change introduce? + +## Checklist + +- [ ] Have you ensured that any changes to the documentation are correctly formatted, in particular are code snippets being correctly displayed? +- [ ] If a new class has been added has a documentation stub `.md` file associated with it been created? +- [ ] Have you ensured that any included hyperlinks are operating correctly? +- [ ] If any documentation page has been created has it been added to `mkdocs.yml` +- [ ] Have you checked your changes with a spell checker? (US English)