Your contributions to the Stellar network will help improve the world’s financial infrastructure, faster.
We want to make it as easy as possible to contribute changes that help the Stellar network grow and thrive. There are a few guidelines that we ask contributors to follow so that we can merge your changes quickly.
- Make sure you have a GitHub account
- Create a GitHub issue for your contribution, assuming one does not already exist.
- Clearly describe the issue including steps to reproduce if it is a bug.
- Fork the repository on GitHub
- Create a topic branch from where you want to base your work.
- This is usually the master branch.
- Please avoid working directly on the
masterbranch.
- Make sure you have added the necessary tests for your changes, and make sure all tests pass.
- Sign the Contributor License Agreement.
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the stellar-lib repository in the Stellar organization.
- Include a descriptive commit message.
- Changes contributed via pull request should focus on a single issue at a time.
- Rebase your local changes against the master branch. Resolve any conflicts that arise.
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). We may suggest some changes or improvements or alternatives.
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new GitHub issue. In this case, it is appropriate to start the first line of a commit with 'doc' instead of an issue number.
- Bug tracker (Github)
- Contributor License Agreement
- Explore the API
- Readme for stellar-lib
- #stellar-dev IRC channel on freenode.org
This document is inspired by:
https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md
https://github.com/thoughtbot/factory_girl_rails/blob/master/CONTRIBUTING.md
https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md