Opened 4 years ago
Closed 4 years ago
#32022 closed Uncategorized (invalid)
Create Pull Request Templates
| Reported by: | Tim Park | Owned by: | nobody |
|---|---|---|---|
| Component: | Uncategorized | Version: | 3.1 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Unreviewed | |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
Hi guys!
I was exploring Github and came across a "Pull Request Template" feature that provides the creator of a PR with a base template. I noticed there is a huge variance between the quality/information/formatting between PR's so this could help set some sort of a standard (especially for beginners!).
At the very minimum, the template could include a standard "Ticket Link" heading for the author to link to the ticket. If we wanted to go further, we could add a "Proposed Changes" or "Comments" heading which might help encourage contributors to be a little more descriptive with their commits.
This change would simply be a new markdown file in the django/.github directory.
P.S.: I'm not sure if this is the right place to put this ticket since this change is to Django repo and not Django itself. Feel free to move this as needed.
Pull Request Template: https://docs.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository
Closing as "invalid" because it's not an issue in Django itself. Moreover I'm not sure if we really want it. Opening a PR is not a desired way to propose changes and start a discussion because an accepted ticket is required for all bugfixes and new features, and adding a template with
ticket-XXXXXseems like overkill. However, feel-free to propose PR template without an accepted ticket.P.S. Note that we're not all "guys" so please use gender neutral greetings, https://heyguys.cc/