Hi all, Wondering if I could get some consensus at to whether a PR template would be beneficial to the Django GitHub repository.
What I have in mind, would be pulling elements from the patch review checklist[1] to be an actual checklist[2] (perhaps in a collapsed section[3]) that appears on the PR itself. Reasons I think it's not a good idea: - we would be duplicating information in 2 places (in the docs and in the PR template), which would be harder to maintain. - when creating your first PR, a comment asks you to review this checklist (links to the docs). So people without this comment have done it before and presumably read it. Reasons I think it's a good idea: - brings the information needed closer to the pr author, without linking them away - I had "read" the checklist, and have since re-read, and there was a lot I hadn't taken in. I think it is still useful for after the first patch. - I like to cross things off lists I am on the fence as to whether it would add value or not. If we think it would add value, I would be happy to create a ticket in Track and raise a PR. Looking forward to hearing your thoughts. Have a wonderful day. Sarah Note: I can see a PR template was briefly mentioned before[4] when discussing adding a pre-commit but I can't mind other mentions so far. Sorry if it has already been discussed. [1]: https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/submitting-patches/#patch-review-checklist [2]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#task-lists [3]: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections [4]: https://groups.google.com/g/django-developers/c/LVWssSldjVs/m/DJcheek3AgAJ -- You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group. To unsubscribe from this group and stop receiving emails from it, send an email to django-developers+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/bc0cb58e-5366-4119-9161-c3cc5dd85012n%40googlegroups.com.
