[Documentation:Developer] Add PR Template Warning (#12342)

JManion32 · web-flow · commit 418de19a6b6f · 2026-02-15T01:36:32.000-05:00
### Why is this Change Important & Necessary? Recently, we have been getting an influx of pull requests that do not comply with Submitty's conventions. This leads to a drawn out review process as we have to wait for contributors to update their PR before we can even review it. ### What is the New Behavior? Added the following to the top of our pull request description template: ```   ``` ### Automated Testing & Documentation We should add more documentation tests that check if comments have been deleted, and verify that the template headers are within the description. ### What steps should a reviewer take to reproduce or test the bug or new feature? Is this change sufficient? Should I add/remove anything?
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,3 +1,12 @@
+<!-- ** Please remove all comment blocks in the description before submitting this PR. ** -->
+
+<!-- NOTE: Please ensure your title and description align with Submitty conventions (see 
+https://submitty.org/developer/getting_started/make_a_pull_request for more details). 
+Each title has a prefix, and a limit of 40 chars. A description template has been 
+provided and must be completed in full. Please also ensure that all CI tests 
+are passing. Pull requests that do not meet these requirements are ineligible for 
+review and may be closed. -->
+
 ### Why is this Change Important & Necessary?
 <!-- Include any GitHub issue that is fixed/closed using "Fixes #<number>" or "Closes #<number>" syntax.  
 Alternately write "Partially addresses #<number>" or "Related to #<number>" as appropriate. -->
