CONTRIBUTING.md

In UBC-MDS/mealprepR: Helps Prepare Your Data Meal

Contributing to mealprepR

This outlines how to propose a change to mealprepR.

Fixing typos

Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the source file.

Prerequisites

Before you make a substantial pull request, you should always file an issue and make sure someone from the team agrees that it's a problem. If you've found a bug, create an associated issue and illustrate the bug with a minimal reproducible example.

Pull request process

• Please create a Git branch for each pull request (PR).
• New code should follow the tidyverse style guide. You can use the styler package to apply these styles, but please don't restyle code that has nothing to do with your PR.
• We use roxygen2, with Markdown syntax, for documentation.
• We use testthat. Contributions with test cases included are easier to accept.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Attribution

The mealprep CONTRIBUTING file is based of the dplyr CONTRIBUTING file.

UBC-MDS/mealprepR documentation built on April 1, 2020, 4:36 a.m.