geosci-labs icon indicating copy to clipboard operation
geosci-labs copied to clipboard

Checklist for reviewers

Open thast opened this issue 6 years ago • 1 comments

PR #12 is the perfect occasion to set the expectations for any PR. We need to create a checklist for reviewers for what is needed in any PR. Here is a first pass:

  • in the PR:
    • Detailed PR and releases notes
  • in the .py:
    • descriptive variables name
    • Reasonably commented codes
    • style (checked by travis)
  • in the notebook:
    • Introduction
    • Purpose
    • Variables description
    • Sketch of the setup

thast avatar Feb 12 '19 23:02 thast

Good points!

yangdikun avatar Mar 17 '19 15:03 yangdikun