astropy-project icon indicating copy to clipboard operation
astropy-project copied to clipboard
verified publisher icon astropy

Code Review Checklist

Open kelle opened this issue 8 years ago • 5 comments

Do we have a code review checklist? If not, I think we should. Maybe we could just crowdsource this by starting a discussion on astropy-dev asking people what they think should go on the list?

Relevant articles which I skimmed:

  • http://blog.smartbear.com/code-review/creating-your-code-review-checklist/
  • https://blog.fogcreek.com/increase-defect-detection-with-our-code-review-checklist-example/

kelle avatar Jan 23 '17 17:01 kelle

This document is a great start! https://github.com/astropy/astropy/blob/master/CONTRIBUTING.md#checklist-for-contributed-code

kelle avatar Mar 20 '17 16:03 kelle

This document should be more discoverable in docs.astropy.org

kelle avatar Mar 20 '17 16:03 kelle

FYI, this is what the contributor guideline link looks like in a github PR: image

eteq avatar Mar 20 '17 16:03 eteq

Documentation of how to do code review should go in https://astropy.readthedocs.io/en/latest/development/workflow/maintainer_workflow.html somewhere.

pllim avatar Apr 14 '20 16:04 pllim

Is this for review or PR? the title of the issue and the discussion is ambiguous.

Also, since the opening of this, we have a PR template, that should have all the pointers for contributors. We still don't have the review checklist, but that's a smaller issue as maintainers are the ones doing the review and they have the gist of it already (having guidelines though useful for onboarding new maintainers)

bsipocz avatar Apr 14 '20 20:04 bsipocz

Looks like a duplicate of https://github.com/astropy/astropy-project/issues/212 . See https://github.com/astropy/astropy-project/issues/212#issuecomment-2253297059

pllim avatar Jul 26 '24 18:07 pllim