CONTRIBUTING.md

In CSHS-hydRology/CSHShydRology: Canadian Hydrological Analyses

How to contribute

Anyone interested is encouraged to contribute to the repository by forking and submitting a pull request.

(If you are new to GitHub, you might start with a basic tutorial and check out a more detailed guide to pull requests.)

Feature request

• Submit an issue on the Issues page or;
• Submit a clean pull request with your code contribution for review. Pull requests will be evaluated by the repository guardians on a schedule and if deemed beneficial will be committed to the master.

Code contributions

• Fork this repo to your Github account
• Clone your version on your account down to your machine from your account, e.g,. git clone https://github.com/[your username]/CSHShydRology.git
• Make sure to track progress upstream (i.e., on our version of CSHShydRology at CSHS-hydRology/CSHShydRology) by doing git remote add upstream https://github.com/CSHS-hydRology/CSHShydRology.git. Before making changes make sure to pull changes in from upstream by doing either git fetch upstream then merge later or git pull upstream to fetch and merge in one step
• Make your changes (bonus points for making changes on a new feature branch)
• Push up to your account
• Submit a pull request to home base (likely master branch, but check to make sure) at CSHS-hydRology/CSHShydRology

Prefer to Email? Email the person listed as maintainer in the DESCRIPTION file of this repo.

Thanks for contributing!

CSHS-hydRology/CSHShydRology documentation built on Aug. 18, 2022, 4:44 p.m.