Merge pull request #588 from tangkong/doc_checklist_prnotes

DOC: add checklist to Pull Request Template
pcdshub · Sep 14, 2023 · e767bb4 · e767bb4
2 parents 8f68987 + 1c6c008
commit e767bb4
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -18,3 +18,13 @@
 <!--
 ## Screenshots (if appropriate):
 -->
+
+## Pre-merge checklist
+- [ ] Code works interactively
+- [ ] Code contains descriptive docstrings, including context and API
+- [ ] New/changed functions and methods are covered in the test suite where possible
+- [ ] Code has been checked for threading issues (no blocking tasks in GUI thread)
+- [ ] Test suite passes locally
+- [ ] Test suite passes on GitHub Actions
+- [ ] Ran ``docs/pre-release-notes.sh`` and created a pre-release documentation page
+- [ ] Pre-release docs include context, functional descriptions, and contributors as appropriate
diff --git a/docs/source/upcoming_release_notes/588-doc_checklist_prnotes.rst b/docs/source/upcoming_release_notes/588-doc_checklist_prnotes.rst
@@ -0,0 +1,23 @@
+588 doc_checklist_prnotes
+#########################
+
+API Changes
+-----------
+- N/A
+
+Features
+--------
+- N/A
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- adds TyphosDisplaySwitcher to TyphosPositionerRowWidget
+- adds checklist to Pull Request Template
+
+Contributors
+------------
+- tangkong