Skip to content

Commit

Permalink
Merge pull request #31 from pyOpenSci/reviewer-template
Browse files Browse the repository at this point in the history
A few edits to the reviewer template
  • Loading branch information
Leah Wasser authored May 21, 2020
2 parents 5b5e323 + a1e034d commit d860d01
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions appendices/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,15 @@ The README should include, from top to bottom:
- [ ] If applicable, how the package compares to other similar packages and/or how it relates to other packages
- [ ] Citation information
#### Usability
Reviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole.
Package structure should follow general community best-practices. In general please consider:
- [ ] The documentation is easy to find and understand
- [ ] The need for the package is clear
- [ ] All functions have documentation and associated examples for use
#### Functionality
- [ ] **Installation:** Installation succeeds as documented.
Expand Down

0 comments on commit d860d01

Please sign in to comment.