Contributing Guide
This guide explains how to contribute to Erupt. Please take a few minutes to read it before opening an issue or a pull request.
Code of Conduct
We have a Code of Conduct that we expect every contributor to follow. Please take the time to read it so you know what is and is not acceptable.
Transparent Development
All our work happens on GitHub. Both core-team members and external contributors go through the same pull-request review process.
Bugs
We use GitHub Issues for bug tracking.
Before filing a bug, please search the existing issues and read the FAQ.
First-time Contribution
If you are new to opening Pull Requests on GitHub, the following resources can help:
Code Contributions
The Erupt team monitors every Pull Request. We review and merge your code, and we may ask for changes or explain why we cannot accept a particular contribution.
How to Open a Pull Request
- Fork the
eruptrepository. All subsequent steps happen in your fork. - From the
masterbranch run:git remote add upstream https://github.com/erupts/erupt - From the
masterbranch run:git pull upstream master - From the
masterbranch run:git push origin master - Switch to the feature branch you are working on (e.g.
docs-fix):git checkout docs-fix - On the
docs-fixbranch run:git rebase origin/master - Make your changes on the
docs-fixbranch and commit them:git commit -a - Push your code:
git push(may need-f) - Open a Pull Request on GitHub