sunpy / sunpy-project

An issue tracker for project wide tasks and suggestions
0 stars 0 forks source link

Checklists for contributors and reviewers #17

Open wtbarnes opened 1 year ago

wtbarnes commented 1 year ago

Inspired by the recent PR to provide a PR cheat sheet (sunpy/sunpy#6346), it may be nice to adapt that information into a contributor checklist that could be a part of the PR template. This could be formatted as a set of tick boxes and once the author of the PR has checked those boxes, it would indicated to the reviewer that the PR is ready to review. This may help to provide on over abundance of comments/reviews before the PR is ready for review and may help to more formally designate whether a PR is ready for review or not.

Additionally, we may want to also consider adding a reviewer checklist (similar to the one provided by astropy, but perhaps less verbose). This could be posted as a separate comment by a bot once the PR is ready for review (potentially indicated by the completion of the contributor checklist). This would help to formalize the review process for a PR and increase transparency as to what we are looking for from a code contribution.