diff options
author | 2021-10-07 21:50:00 +0100 | |
---|---|---|
committer | 2021-10-07 21:50:00 +0100 | |
commit | 1bb70f38cb6da64df3b46688e81b860b172ad49d (patch) | |
tree | 01fd16febc4e7cca00aca1908aa3a2ab875f75be /.github | |
parent | chore: Add comments to instruct users (diff) |
chore: Replace examples with comments
Diffstat (limited to '.github')
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE/pull_request.md | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request.md b/.github/PULL_REQUEST_TEMPLATE/pull_request.md index 382ee2a7..34359cec 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request.md @@ -1,21 +1,20 @@ ## Summary -This PR introduces [ brief summary ] in accordance with site#[ issue number ] +<!-- Please provide a brief description of this PR along with the related issue it fixes --> + ## Description of changes -- `foo` was refactored to `bar` -- The baz feature was implemented -- ... +<!-- This should look like a condensed down version of your commit history --> -<!-- For your PR to be accepted, these must all be completed --> ### I confirm I have: +<!-- Replace [ ] below with [X] to check the boxes --> - [ ] 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.) -<!-- Please remove the below section if you haven't edited files under pydis_site/apps/api/models --> ### I have changed API models and I ensure I have: +<!-- Please remove this section if you haven't edited files under pydis_site/apps/api/models --> - [ ] Opened a PR updating the model on the [API GitHub Repository](https://github.com/python-discord/api) **OR** |