Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Checklist for reviewers #15

Open
thast opened this issue Feb 12, 2019 · 1 comment
Open

Checklist for reviewers #15

thast opened this issue Feb 12, 2019 · 1 comment
Assignees
@lheagy @thast

Comments

@thast
Copy link
Member

thast commented Feb 12, 2019 •
edited
Loading

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
Copy link
Member

Good points!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lheagy lheagy

@thast thast

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@yangdikun @lheagy @thast