Skip to content

Commit 800b88a

Browse files
authored
clarify requirements re: BiocCheck and Authors@R (#175)
1 parent 8c7bae9 commit 800b88a

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/package-review-checklist.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The functionality should be sufficiently documented in man pages with runnable e
2121
## General package development
2222

2323
- [ ] `R CMD build` without errors, warnings and notes. Any not fixed should be justified.
24-
- [ ] Package passes `BiocCheck::BiocCheck()`, `BiocCheck::BiocCheckGitClone()`. Any not fixed should be justified.
24+
- [ ] Package passes `BiocCheck::BiocCheck()` when run on the source directory.
2525
- [ ] File names. Do not use filenames that differ only in case, as not all file systems are case-sensitive.
2626
- [ ] Package size. Size of tarball <= 10MB.
2727
- [ ] `R CMD check --no-build-vignettes` within 10 minutes.
@@ -79,9 +79,9 @@ Refer to the [DESCRIPTION](https://contributions.bioconductor.org/description.ht
7979

8080
N.B. Authors@R:
8181

82-
- [ ] Use of Authors@R should be used instead of individual Maintainer and Author
83-
fields. While its not wrong to use Maintainer/Author, Authors@R should be
84-
strongly encouraged. Using both Authors@R and Maintainer/Author is not allowed!
82+
- [ ] Use of Authors@R is preferred over Maintainer and Author fields. While
83+
its not wrong to use Maintainer/Author, Authors@R should be strongly
84+
encouraged. Using both Authors@R and Maintainer/Author is not allowed!
8585

8686
- [ ] It is strongly encouraged to include a `fnd` entry in Authors@R with any
8787
relevant Grant Ids to trace funding activities. Not required but encouraged.

0 commit comments

Comments
 (0)