aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar scragly <[email protected]>2019-12-12 14:38:01 +1000
committerGravatar scragly <[email protected]>2019-12-12 14:38:01 +1000
commitef1ec4d48bc17b9fceb99494a8b67c36d960e07e (patch)
tree5d9ba7eb255cc04f6e89b21184bd67c32d080c49
parentRemove leftover automatically generated templates. (diff)
Refine the pull request sections and use proper comments.
-rw-r--r--.github/pull_request_template.md32
1 files changed, 22 insertions, 10 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index c8b15b09..cbc9830f 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,21 +1,33 @@
---
name: Pull Request
-about: A simple pull request template.
-issue: Issue # if applicable
+about: Request to pull code changes into the repository.
+title: ''
+assignees: ''
---
-Provide a simple description of what the PR achieves.
+## Relevant Issues
+<!-- List relevant issue tickets here. -->
+<!-- Say "Closes #0" for issues that the PR resolves, replacing 0 with the issue number. -->
-## Pull Request Details
-Please ensure your PR fulfills the following criteria:
+## Description
+<!-- Describe the changes made in the pull request. -->
-- [ ] Have you joined the [PythonDiscord Community](https://pythondiscord.com/invite)?
-- [ ] Were your changes made in a Pipenv environment?
-- [ ] Does flake8 pass (```pipenv run lint```)
+## Reasoning
+<!-- Outline the reasoning for the changes made. -->
-## Additional information
-Provide any additional information or clarifications here. \ No newline at end of file
+## Screenshots
+<!-- Remove this section if the changes don't impact anything user-facing. -->
+<!-- You can add images by just copy pasting them directly in the editor. -->
+
+
+## Did you:
+<!-- These are required when contributing. -->
+<!-- Replace [ ] with [x] to mark items as done. -->
+
+- [ ] Join the [**Python Discord Community**](https://discord.gg/python)
+- [ ] Make changes in the **Pipenv** environment
+- [ ] **Lint your code** (`pipenv run lint`)