CONTRIBUTING.md

In WeiSong-bio/roryk-bcbioSinglecell: Single-Cell RNA-Seq Utilities

Contributing to bcbioSingleCell

• For all changes, fork or create a new branch, then issue a pull request that will be reviewed.
• Do not commit changes directly to master branch.
• Support is only provided for the current release version.

Package style syntax

Attempt to follow these style guides, by priority: (1) Bioconductor coding style; (2) tidyverse style guide; (3) Google R style guide.

• Object and function parameter arguments should be formated in lowerCamelCase.
• Use spaces instead of tabs. Indent with 4 spaces.
• Use <- and not = for assignment.
• Explicitly define if/then statements using opening and closing brackets ({, }).
• else declarations should be on the same line as the closing bracket.
• Use spaces around assignment operators (<-), brackets ({), and comma delimiters (e.g. c("foo", "bar") not c("foo","bar").

Required checks

lintr::lint_package()
devtools::document()
devtools::check()
BiocCheck::BiocCheck(getwd())
pkgdown::build_site()

WeiSong-bio/roryk-bcbioSinglecell documentation built on July 6, 2019, 12:03 a.m.