https://github.com/bioconductor/pkgrevdocs

Training Material for Community Reviewers
https://github.com/bioconductor/pkgrevdocs

Last synced: 6 months ago
JSON representation

Training Material for Community Reviewers

• Host: GitHub
• URL: https://github.com/bioconductor/pkgrevdocs
• Owner: Bioconductor
• License: other
• Created: 2021-03-18T17:19:09.000Z (about 5 years ago)
• Default Branch: devel
• Last Pushed: 2025-02-19T15:28:14.000Z (over 1 year ago)
• Last Synced: 2025-02-19T16:31:00.242Z (over 1 year ago)
• Language: TeX
• Homepage: http://contributions.bioconductor.org/
• Size: 2.43 MB
• Stars: 8
• Watchers: 12
• Forks: 19
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: news-file.Rmd
  • License: license-file.Rmd
  • Citation: citation-file.Rmd

Awesome Lists containing this project

README

          
Bioconductor Packages: Guidelines for Developers and Reviewers

==============================================================

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) 

[![GitHub Actions](https://github.com/Bioconductor/pkgrevdocs/workflows/build_deploy/badge.svg)](https://github.com/Bioconductor/pkgrevdocs/actions)

[_Bioconductor_](https://bioconductor.org/)'s guide for package development, maintenance, and peer review.

[Read it here](https://bioconductor.github.io/pkgrevdocs/).

## Contributing

### Suggestions and updates

This book contains our guidelines for packages contributed to the [_Bioconductor_](https://bioconductor.org/) suite of packages.

These guidelines are always a work in progress - corrections, suggestions and general improvements are welcome as [issue submissions in this repository](https://github.com/Bioconductor/pkgrevdocs/issues/new).

Open discussions are welcome in our [Zulip](https://community-bioc.zulipchat.com/).

You can also suggest changes by editing the `.Rmd` files that are at the root of this repository and submitting a [pull request](https://github.com/Bioconductor/pkgrevdocs/pulls).

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](https://github.com/Bioconductor/pkgrevdocs/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`).

```r

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)