Contributing.md

In UBC-MDS/BlackBoxR:

Contributing

Persons contributing to this project agree to the code of conduct and agree to the potential redistribution of their code under our license.

How to contribute

The easiest way to contribute is opening an issue on Github. You can make suggestions that are small or large. If you are familiar with the project, the programming language, and the overall layout of the project, you can submit a pull request (instructions below). Upon submission of a pull request one of the maintainers will inspect the PR and either accept or reject (a reason for rejection will be provided).

What to contribute

Contributions can be small suggestions (spelling mistakes or refinement of documentation) or large additions (added functionality or restructuring existing code). If you decide to open an issue please include a short description of the problem and a minimal reproducible example (this helps the maintainers verify your problem).

Pull Requests

Fork, then clone the repo:

    git clone https://github.com/UBC-MDS/BlackBox_R

Make your changes (committing and ideally testing along the way)

Push to your fork and submit a pull request.

• Write tests.
• Write a good commit message

Attribution

This document was adapted from here and here

UBC-MDS/BlackBoxR documentation built on May 25, 2019, 1:35 p.m.