Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

56 lines (41 loc) · 1.93 KB
Raw

Contributing

(This contribution guidelines are based on Software Carpentry and Data Carpentry contribution instructions) We welcome contributions of all kinds: fixes to existing code and documentation, bug reports, reviews of proposed changes.

Contributor Agreement

By contributing, you agree that we may redistribute your work under this project license.

How to Contribute

The easiest way to get started is to file an issue.

  1. If you have a GitHub account, or are willing to create one, but do not know how to use Git, you can report problems or suggest improvements by an issues. This allows us to assign the item to someone and to respond to it in a threaded discussion.

  2. If you are comfortable with Git, and would like to add or change material, you can submit a pull request (PR). Instructions for doing this are included below.

Using GitHub

If you choose to contribute via GitHub, you may want to look at How to Contribute to an Open Source Project on GitHub. In brief:

We use GitHub flow to manage changes:
1. Create a new branch in your desktop copy of this repository for each significant change.
2. Commit the change in that branch.
3. Push that branch to your fork of this repository on GitHub.
4. Submit a pull request from that branch to the [master repository][repo].
5. If you receive feedback, make changes on your desktop and push to your branch on GitHub: the pull request will update automatically.