We love to pull requests from everyone! We follow the standard Git workflow of fork -> change -> pull request -> merge -> update fork -> change ... (repeat forever).
If you are new to open source, we recommend GitHub's excellent guide on "How to Contribute to Open Source". In addition, please feel free to reach out to any of the maintainers or other community members if you are struggling as we are here to help you learn!
Before getting started, please make sure you've read the README to get a primer on our project. Augur's documentation can be found here.
If you're experiencing an issue with Augur or have a question you'd like help answering, please feel free to open an issue. To help us prevent duplicates, we kindly ask that you briefly search for your problem or question in our issues before opening a new one.
Please note that if you open a bug report and your issue does not follow our template, we cannot help you until you have provided us all the relevant information in that format. Respectfully, we do not have the time to try and recreate an error given with minimal or no context, so by providing this information you are helping us help you!
To see the template referred to in the above section, click on New Issue, then click on the Get Started button on the Bug Report option. A dialogue box populated with descriptions of what to put in each section, will pop up on a new page. Kindly replace the descriptions with your comments to the best of your ability, and please include screenshots and error logs if applicable.
- Fork and clone this repo:
$ git clone github.com:your-username/augur.git
$ cd augur/
$ git remote add upstream https://github.com/chaoss/augur.git-
Follow the development installation instructions.
-
Create a new branch
$ git checkout -b my-new-branch-
Make your change(s).
-
Commit the change(s) and push to your fork
$ git add .
$ git commit -s -m "This is my first commit"
$ git push -u origin my-new-branch- Then, submit a pull request.
At this point, you're waiting on us. We like to at least comment on pull requests within three business days (and, typically, one business day).
Once one of our maintainers has had a chance to review your PR, we will either mark it as needs review and provide specific feedback on your changes, or we will go ahead and complete the pull request.
To contribute to this project, you must agree to the Developer Certificate of Origin (DCO) by the CHAOSS charter for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal right to make the contribution. To signify that you agree to the DCO for contributions, you simply add a line to each of your git commit messages. For example:
Signed-off-by: Jane Smith <jane.smith@example.com>
This can be easily done by using the -s flag when running the git commit command,
$ git commit -s -m “my commit message w/signoff”
To ensure all your commits are signed, you may choose to configure git properly by editing your global .gitconfig
Any pull requests containing commits that are not signed off will not be eligible for merge until the commits have been signed off.
Remember to sync your fork with the main branch regularly, by taking the following steps:
-
Setup your upstream branch to point to the URL of the main Augur repo
https://github.com/chaoss/augur.git. -
Next, in the root folder of the project, on the
mainbranch, run:
git remote add upstream https://github.com/chaoss/augur.git
Whenever you need to make changes, make sure your main branch is in sync with the main repository, by checking out to the main branch and running:
git pull upstream main
git push origin master
- Stable documentation (
mainbranch) - Nightly/developer build documentation (
devbranch) (warning: this is should be considered an unstable branch and should not be used for production) - Live Augur demo
- Website
- Get Involved
- Metrics
- Evolution Metrics Working Group
- Common Metrics Working Group
- Risk Metrics Working Group
- Value Metrics Working Group
- Diversity & Inclusion Metrics Working Group
- How to contribute to Open Source
- GitHub's Git Handbook
- GitHub's "Hello World" tutorial
- Understanding the GitHub Flow
- Commit message style guidelines
- No-nonsense Git reference (best to have a cursory understanding of Git before hand)