From 2801567cbff4c2a8774d5598e06c9c7e3aa05a8b Mon Sep 17 00:00:00 2001 From: Leah Wasser Date: Thu, 20 Jun 2019 15:05:12 -0600 Subject: [PATCH 1/3] a few edits to the reviewer template --- content/appendices/templates.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/content/appendices/templates.md b/content/appendices/templates.md index 922249d1..38d63047 100644 --- a/content/appendices/templates.md +++ b/content/appendices/templates.md @@ -47,13 +47,14 @@ The package includes all the following forms of documentation: Readme requirements The package meets the readme requirements below: -- [ ] Package has a README.md file in the root directory. +- [ ] Package has a user-friendly README.md file in the root directory. The README should include, from top to bottom: - [ ] The package name - [ ] Badges for continuous integration and test coverage, the badge for pyOpenSci peer-review once it has started (see below), a repostatus.org badge, and any other badges. If the README has many more badges, you might want to consider using a table for badges, see this example, that one and that one. Such a table should be more wide than high. -- [ ] Short description of goals of package, with descriptive links to all vignettes (rendered, i.e. readable, cf the documentation website section) unless the package is small and there’s only one vignette repeating the README. +- [ ] Short description of goals of package +- [ ] Dscriptive links to all vignettes (rendered, i.e. readable, cf the documentation website section) unless the package is small and there’s only one vignette repeating the README. - [ ] Installation instructions - [ ] Any additional setup required (authentication tokens, etc) - [ ] Brief demonstration usage @@ -61,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. From a9b67df3b740bdba4fd73a3ffbcc9273d081cdd1 Mon Sep 17 00:00:00 2001 From: Leah Wasser Date: Mon, 24 Jun 2019 11:26:56 -0600 Subject: [PATCH 2/3] typo fixed --- content/appendices/templates.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/appendices/templates.md b/content/appendices/templates.md index 38d63047..05aba1ba 100644 --- a/content/appendices/templates.md +++ b/content/appendices/templates.md @@ -54,7 +54,7 @@ The README should include, from top to bottom: - [ ] The package name - [ ] Badges for continuous integration and test coverage, the badge for pyOpenSci peer-review once it has started (see below), a repostatus.org badge, and any other badges. If the README has many more badges, you might want to consider using a table for badges, see this example, that one and that one. Such a table should be more wide than high. - [ ] Short description of goals of package -- [ ] Dscriptive links to all vignettes (rendered, i.e. readable, cf the documentation website section) unless the package is small and there’s only one vignette repeating the README. +- [ ] Descriptive links to all vignettes (rendered, i.e. readable, cf the documentation website section) unless the package is small and there’s only one vignette repeating the README. - [ ] Installation instructions - [ ] Any additional setup required (authentication tokens, etc) - [ ] Brief demonstration usage From a8f67b453e39b4cd8ff05eec207fb72f333032fd Mon Sep 17 00:00:00 2001 From: Leah Wasser Date: Fri, 28 Jun 2019 15:34:19 -0600 Subject: [PATCH 3/3] remove "user friendly" - too ambiguous! --- content/appendices/templates.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/appendices/templates.md b/content/appendices/templates.md index 05aba1ba..0e32c228 100644 --- a/content/appendices/templates.md +++ b/content/appendices/templates.md @@ -47,7 +47,7 @@ The package includes all the following forms of documentation: Readme requirements The package meets the readme requirements below: -- [ ] Package has a user-friendly README.md file in the root directory. +- [ ] Package has a README.md file in the root directory. The README should include, from top to bottom: