CONTRIBUTING.md

In UBC-MDS/CrossR: CrossR

Contributing

CrossR is an open source project, and we welcome contributions of all kinds. By participating in this project, you agree to abide by the code of conduct.

How to contribute

Git flow

• To Get Started: Fork, then clone the repository - this will be your working space:

git clone https://github.com:your-username/CrossR.git

• For each contribution:

  • Make sure the existing tests pass.

  • Make your changes.

  • Add tests for the changes you made.

  • Ensure existing and new tests pass.

• Commit your changes to your forked repository.

• ALWAYS sync your fork to the original repository before sending a pull request. In order to this, follow the steps explained in the links below.

  • Configuring a remote for a fork
  • Syncing a fork

• Push your changes to your forked repository.

• Submit a pull request to all owners of the master repository.

Commit details

• Commit often throughout the work process.

• Make sure your commit messages are clear and informative.

Attribution

• This document is adapted from:
  • r-novice-inflammation / CONTRIBUTING.md
  • factory-bot-rails / CONTRIBUTING.md.

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