Checklist for reviewers

geoscixyz / geosci-labs

collection of notebook-apps for concepts in applied geophysics

https://geosci.xyz

MIT License

50 stars 35 forks source link

Checklist for reviewers #15

Open thast opened 5 years ago

thast commented 5 years ago

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

yangdikun commented 5 years ago

Good points!