Skip to content

Added a Pull Request Template #17856

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Mar 4, 2024
Merged

Added a Pull Request Template #17856

merged 1 commit into from
Mar 4, 2024

Conversation

erosselli
Copy link
Contributor

@erosselli erosselli commented Feb 14, 2024 •
edited
Loading

Description

As discussed in this Django Forum thread, this is a proposal for a Pull Request Template for Django. Any feedback or comments are welcome!

LilyFirefly
LilyFirefly reviewed Feb 15, 2024
View reviewed changes
smithdc1
smithdc1 reviewed Feb 15, 2024
View reviewed changes
Copy link
Member

@smithdc1 smithdc1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it bad that as a somewhat regular contributor, I see myself just deleting this 😬

@felixxm
Copy link
Member

felixxm commented Feb 15, 2024

Is it bad that as a somewhat regular contributor, I see myself just deleting this 😬

No, it's not 🤗 I'd be forced to do the same every time. We could put this in a comment (<!-- ... -->) to reduce inconvenience for regular contributors.

rixx
rixx reviewed Feb 15, 2024
View reviewed changes
.github/pull_request_template.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that generally expected? I feel like having the tests in the checklist is good enough – asking people to describe the tests they've written feels like a sure-fire way to get the paragraph deleted entirely.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree 👍

Additionally when we're also draining people's cognitive resources by adding too much stuff to read so repetitive things should be removed.

Less is more :)

.github/pull_request_template.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As Trac isn't super intuitive, I think it would be helpful to tell users what to do exactly (ie set "has patch" on the ticket).

Copy link
Contributor