aboutsummaryrefslogtreecommitdiffstats
path: root/.github/PULL_REQUEST_TEMPLATE
diff options
context:
space:
mode:
authorGravatar Vivaan Verma <[email protected]>2021-10-07 21:27:11 +0100
committerGravatar GitHub <[email protected]>2021-10-07 21:27:11 +0100
commitbb23a46f84f724552ca554a93a2536e65f36db25 (patch)
treec1fd522a5b530b474762eadfb3e0bc370c4b216e /.github/PULL_REQUEST_TEMPLATE
parentMerge pull request #604 from python-discord/jb3/add-site-local-svc (diff)
Add a pull request template
This pull request template was mainly added so that the second bullet point in [this PR comment](https://github.com/python-discord/api/pull/17#issuecomment-933739292) can be addressed.
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE')
-rw-r--r--.github/PULL_REQUEST_TEMPLATE/pull_request.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request.md b/.github/PULL_REQUEST_TEMPLATE/pull_request.md
new file mode 100644
index 00000000..34e56aec
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/pull_request.md
@@ -0,0 +1,19 @@
+## Summary
+This PR introduces [ brief summary ] in accordance with site#[ issue number ]
+
+## Description of changes
+- `foo` was refactored to `bar`
+- The baz feature was implemented
+- ...
+
+### I confirm I have:
+- [ ] Joined the [Python Discord community](discord.gg/python)
+- [ ] Read the [Code of Conduct](https://www.pydis.com/pages/code-of-conduct) and agree to it
+- [ ] I have discussed implementing this feature on the relevant service (Discord, GitHub, etc.)
+
+### If I have changed any models (edited files under the `site/apps/api/models` directory), I ensure I have:
+- [ ] Opened a PR updating the model on the [API GitHub Repository](https://github.com/python-discord/api)
+
+**OR**
+
+- [ ] Opened an issue on the [API GitHub Repository](https://github.com/python-discord/api) explaining what changes need to be made