CONTRIBUTING.md

In UBC-MDS/obesity-explorer-R: Obesity Explorer Dashboard

Contributing to this Project

This dashboard repo is an academic project organized under the umbrella of the UBC's Master of Data Science program. As such, the authors welcome input about the analysis, but we are not accepting community contributions prior to February 15, 2021.

Our Development Philosophy

• We use a fork + pull-request (PR) approach to development. The main branch is protected and we require at least one reviewer per PR.

• We search Github issues before contributing a PR to ensure a similar query has not yet been posed or closed.

• We aim to create minimal reproducible examples whenever discussing bugs or problems. We attempt to do this on Docker before reporting an issue, when possible.

• We document everything with roxygen2, docopt, or docstrings.

• We strive to write code that adheres to the tidyverse style guide (for R) and PEP8 (for Python). We do this for consistency and ease of collaboration, rather than for its own sake. When appropriate, we welcome deviations from style.

• We test our code using testthat or analogous frameworks.

• We try to write code that will be reproducible across platforms and time.

For general guidance on how to contribute, please consult the tidyverse development contributing guide.

Code of Conduct

This project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

UBC-MDS/obesity-explorer-R documentation built on Feb. 7, 2021, 4:37 a.m.