Open Flexonze opened 6 days ago
On most of my projects, I love to use the template, attached below for my PRs. It gives clarity to PR plus easy to read. I'm open to discussion, about what checklist points should be in here:
What kind of change does this PR introduce?
What needs to be tested by QA?
Select items that apply to your PR; make sure to provide more details below each of the selected items
[ ] This PR introduces a breaking change
[ ] There are additions to environment (secrets, database config, etc.)
[ ] Updates to dev/qa docs are pending post merger of this PR
[ ] There is some context to this PR, like links to slack discussion, related tickets. etc.
Keep it simple! This is a small package and I think the PR template should be short, concise and really easy to fill out. The less verbose the better IMO.
I like the related issue part, this would make sure an issue exist and will help with context. I also like that you can mention if there are new sercrets/config.
What I'm thinking is something like this, let me know what you think:
This PR add this and that and whatever...
https://github.com/Flexonze/django-auto-actions/issues/5
Did you perform a self-review of your code?
Did you add yourself in CONTRIBUTORS.md?
Did you update the tests & documentation?
Are there additions to enviroment (secrets)?
Any additionnal notes?
I like the idea of keeping things simple. Also, the template looks good to me. I will go ahead and create a PR for it.
To help with contributions, it would be nice to have a simple pull request template which would include a simple checklist before requesting a review. Things like: