README.md

Bioconductor Packages: Guidelines for Developers and Reviewers

Bioconductor's guide for package development, maintenance, and peer review. Read it here.

Contributing

Suggestions and updates

This book contains our guidelines for packages contributed to the Bioconductor suite of packages. These guidelines are always a work in progress - corrections, suggestions and general improvements are welcome as issue submissions in this repository. Open discussions are welcome in our Slack. You can also suggest changes by editing the .Rmd files that are at the root of this repository and submitting a pull request. An "Edit this page" link in the side bar on the right of each book chapter will take you directly to the relevant page on the GitHub repository to make such changes. Please target your pull requests to the devel branch.

Technical details

Deployment is done via GitHub Actions:

• whenever there's a push to devel, the book is built and its content is then pushed to the gh-pages branch.

To preview the book locally - preferably before opening a pull request and while reviewing it - use the following code in an R console with the working directory set to the root of this repository, making sure that all the dependencies of the book are available (see file DESCRIPTION).

bookdown::render_book()

Original sources

This book is based on contents from the following original sources:

• https://bioconductor.org
• https://bioconductor.org/developers/package-guidelines/

The template used for this book is credited to the book rOpenSci Packages: Development, Maintenance, and Peer Review:

• https://devguide.ropensci.org/ (deployed book)
• https://github.com/ropensci/dev_guide (source)