@windingtree/wt-contracts
Version:
Smart contracts of the Winding Tree platform
23 lines (17 loc) • 1.35 kB
Markdown
Contributing to Winding Tree
=======
We really appreciate and value contributions to Winding Tree. Please take 5' to review the items listed below to make sure that your contributions are merged as soon as possible.
## Getting Started
* Login with your GitHub account or create one now
## Contributing with an Issue
1. If you find a mistake and you're not sure how to fix it, or you don't know how to do a pull request, then you can file an Issue. Filing an Issue will help us see the problem and fix it.
2. Create a [new Issue](https://github.com/windingtree/wt-contracts/issues/new) clearly described!
## Contributing with a Pull Request
1. [Fork](https://github.com/windingtree/wt-contracts/) the Winding Tree repository. Work on your fork.
2. Create a new branch on which to make your change, e.g. `git checkout -b fix/my_bug_fix` start branch names with _fix_, _feat_, _docs_ or _refactor_.
3. Make commits of logical and atomic units.
4. Please do one pull request PER functionality, to avoid large merges.
5. Commit your change. Include a commit message describing the correction.
6. In case of being necessary make sure you have added the necessary tests for your changes. Run _all_ the tests to assure nothing else was accidentally broken.
7. Submit a pull request against the Winding Tree repository.
Thanks for your time and code!