Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Create pull request template #43
hallgchris left a comment •
For inspiration, here's Rome2rio's PR template
Quite extra, and no one uses the checkboxes anyway, but I feel like we could take a bit from it. I find that although it's nice to think that we'd remember to do things like include screenshots or whatever, it's easy to forget and I do find it useful to have right in front of me.
Perhaps in the Description section we could include a reminder that there should be screenshots if relevant, and state that there should be one conceptual change (if that can be tied into the wording in some non-awkward way).
In the testing section, a small reminder to write automated tests, if relevant, could also be good.
Finally, what do you think about a pre-merge checklist? Could be all on one line, specifying that all feedback should be addressed, will squash and merge, whatever.
Idk, maybe this is all too extra
Also if I remember, I'll remove the excerpt from Rome2rio's repo in a few days. Probably not the best idea go around posting that
Definitely agree with the checkboxes as we will just click it without reading it.
My workplace does that atm as well, so I'll add a screenshots section (if relevant)
Unfortunately we aren't at the stage where we have automated testing. With Github Actions/Travis this will be done automatically anyway.
I think this should be known already by submitting a PR.
Good suggestions though!