From b449ca848dbf203c99fa856612e79976afa41511 Mon Sep 17 00:00:00 2001
From: Nicolas Perez <nicolas_perez@brown.edu>
Date: Sun, 2 Jun 2024 16:05:33 -0400
Subject: [PATCH] doc: Added general pull request template with directions for
 doc only changes and squash merges

---
 .../pull_request_template.md                  | 40 +++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md

diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
new file mode 100644
index 000000000..3c970783d
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -0,0 +1,40 @@
+# Pull Request Template
+
+## Summary
+
+* [Briefly describe the changes made in this PR.]
+* [Include any relevant context, such as the issue or feature being addressed.]
+
+## Changes Made
+
+* [List specific files or directories affected by these changes]
+* [Describe any significant updates, rewrites, or new code added]
+* [Mention any removed or deleted files or code]
+
+## Relevant Details
+
+* **Affected Code**: [List specific code paths, functions, or classes changed or updated]
+* **Impact**: [Explain how the changes affect the project's functionality, performance, or security]
+* **New Features/Changes**: [Describe new features or significant changes added in this PR]
+* **Fixed Issues**: [List specific issues or bugs fixed by these changes]
+
+## Verification
+
+To verify this PR, you can:
+
+* Run automated tests or scripts to ensure the changes do not introduce errors
+* Review code for style, security, and best practices
+* Verify that all changed files are properly formatted and consistent
+
+## Additional Information (Optional)
+
+[Add any additional context, explanations, or requests that are relevant to this PR.]
+
+**Important Notes**
+
+* If this pull request only contains documentation changes (e.g., updating
+READMEs, adding new wiki pages), please add `[no ci]` to the commit title.
+This will skip unnecessary CI checks and help reduce build times.
+* When squashing multiple commits on merge, use the following format for
+your commit title: `<module>:<commit title> (#<issue_number>)`. For example: `utils: Fix typo in utils.py (#1234)`
+* Please ensure that this PR follows our contributing guidelines, available at [](README.md). This includes formatting code according to our style guide and ensuring that all changes are thoroughly tested.