Skip to content

Commit 30bda0b

Browse files
authored
Update What to Expect Section (#113)
* Fix link * Fixes typo Fix #109 * Update what to expect
1 parent 0444a35 commit 30bda0b

File tree

1 file changed

+44
-19
lines changed

1 file changed

+44
-19
lines changed

package-submission.Rmd

Lines changed: 44 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,12 @@ package maintenance responsibilities. Package authors are expected to:
168168
DESCRIPTION file. This field indicates a particular web page for submitting
169169
bug reports and questions.
170170

171+
* Ensure the maintainer email in the DESCRIPTIONS stays accurate and
172+
reachable. The maintainer email in the DESCRIPTION is the definitive contact
173+
_Bioconductor_ will use. It is important to keep this email up-to-date to
174+
ensure we can contact you if your package is failing or to notify you of any
175+
important upcoming impactful events. If the email is not reachable your
176+
package would be in jeopardy of removal.
171177

172178
## Submission
173179

@@ -244,22 +250,19 @@ use of existing data in a Bioconductor package. See development section on
244250

245251
* A new package is initially labeled as `1. awaiting moderation`.
246252
A _Bioconductor_ team member will take a very brief look at your
247-
package, to ensure that it is intended for _Bioconductor_. Appropriate
248-
packages will be re-labelled `2. review in progress` and a reviewer will be
249-
automatically assigned. Your assigned reviewer will address your concerns and
250-
help you through the review process. The entire review process typically
251-
takes between 2 and 6 weeks. If there is no response after 3 to 4 weeks,
252-
package reviewers may close the issue until further updates, changes, and/or
253-
commentary are received.
253+
package, to ensure that it is not doing anything malicious or
254+
inappropriate. Packages that pass this stage will be labelled
255+
`pre-check passed`.
254256

255-
* If in the pre-review process there are identified larger issues with the
256-
package, a label `3e. pending pre-review changes` or a more specific flag of
257-
package issue will be assigned. Please address any pre-review identified
258-
issues and comment back for the package admininstrators to re-evaluate.
257+
* The moderator will add your package as a repository to the
258+
git.bioconductor.org git server, copy the SSH keys from your github
259+
account to the [BiocCredentials application][] application and the issue labelled
260+
`pre-review`.
259261

260-
* Please be courteous with your package reviewers and always follow the
261-
_Bioconductor_ [Code Of Conduct][] with correspondence. Please allow 2-3 weeks
262-
for reviewers to assess your package.
262+
ALL CHANGES TO YOUR PACKAGE must be pushed to the
263+
git.bioconductor.org repository created in this step. See the [New package
264+
workflow][] for instructions on pushing changes to your git.bioconductor.org
265+
repository.
263266

264267
* The package will be submitted to the _Bioconductor_ build
265268
system (BBS). The system will check out your package from GitHub and move it
@@ -290,11 +293,23 @@ use of existing data in a Bioconductor package. See development section on
290293
`0.99.z` format. When accepted and released, your package's version number
291294
will be automatically incremented to 1.0.0.
292295

296+
* If in the pre-review process there are identified larger issues with the
297+
package, a label `3e. pending pre-review changes` or a more specific flag of
298+
package issue will be assigned. Please address any pre-review identified
299+
issues and comment back for the package admininstrators to re-evaluate.
300+
293301
* Once your package builds and checks without errors or (avoidable)
294-
warnings, a _Bioconductor_ team member will provide a technical
295-
review of your package. Other _Bioconductor_ developers and users
296-
with domain expertise are encouraged to provide additional community
297-
commentary. Reviewers will add comments to the issue you created.
302+
warnings, the package is assigned a reviewer. The package will be
303+
labelled `2. Review in progress`.
304+
305+
* The reviewr will provide a technical review of your package. Other
306+
_Bioconductor_ developers and users with domain expertise are encouraged to
307+
provide additional community commentary. Reviewers will add comments to the
308+
issue you created.
309+
310+
* Please be courteous with your package reviewers and always follow the
311+
_Bioconductor_ [Code Of Conduct][] with correspondence. Please allow 2-3 weeks
312+
for reviewers to assess your package.
298313

299314
* Respond to the issues raised by the reviewers. You _must_ respond to
300315
the primary reviewer, and are strongly encouraged to consider
@@ -318,6 +333,15 @@ use of existing data in a Bioconductor package. See development section on
318333
closed. All updates to your package will be through the
319334
[_Bioconductor_ Git Server][gitver].
320335

336+
337+
Please be mindful that reviewers are volunteers and package reviews are not
338+
the only responsibility of _Bioconductor_ team members. We like to see the
339+
review process progress by updates from the submitter or by comments from the
340+
reviewer within 2-3 weeks. The entire review process typically takes between 2
341+
and 6 weeks. If there is no response after 3 to 4 weeks, package reviewers may
342+
close the issue until further updates, changes, and/or commentary are received.
343+
344+
321345
## Following Acceptance {#afteraccept}
322346

323347
Following acceptance of a package:
@@ -339,7 +363,8 @@ Following acceptance of a package:
339363
[Version numbering][versioning] guidelines. If developers don't
340364
bump the version, the changes made to their package *do not propagate*
341365
to the _Bioconductor_ web site and package repository.
342-
366+
* Devlopers should make sure the maintainer email in the DESCRIPTION stays
367+
accurate and reachable.
343368

344369
## Additional Support {#support}
345370

0 commit comments

Comments
 (0)