d656025378
* Moved audit to root directory. * Moved code of conduct, contributing and licence files. * Removed travis config and badge. * Updated repository links in CONTRIBUTING. * Moved Gitter badge to main readme. Updated links to contributing and licence. * Updated main readme. * Moved references to main readme. * Renamed token-bridge to oracle. * Update README.md Co-Authored-By: rzadp <rzadp@student.mini.pw.edu.pl>
29 lines
1.6 KiB
Markdown
29 lines
1.6 KiB
Markdown
## Contributing
|
|
|
|
Thank your for contributing to this project! We welcome collaborators and expect users to follow our [code of conduct](CODE_OF_CONDUCT.md) when submitting code or comments.
|
|
|
|
1. Fork the repo ( https://github.com/poanetwork/tokenbridge/fork ).
|
|
2. Create your feature branch (`git checkout -b my-new-feature`).
|
|
3. Write tests that cover your work.
|
|
4. Commit your changes (`git commit -am 'Add some feature'`).
|
|
5. Push to your branch (`git push origin my-new-feature`).
|
|
6. Create a new PR (Pull Request).
|
|
|
|
### General
|
|
|
|
* Commits should be one logical change that still allows all tests to pass. We prefer smaller commits if there could be two levels of logic grouping. The goal is to provide future contributors (including your future self) the reasoning behind your changes and allow them to cherry-pick, patch or port those changes in isolation to other branches or forks.
|
|
* If during your PR you reveal a pre-existing bug and know how to fix it:
|
|
1. If you can isolate the bug, fix it in a separate PR.
|
|
2. If the fix depends on your other commits, add it in a separate commit to the same PR.
|
|
|
|
In either case, try to write a regression test that fails because of the bug but passes with your fix.
|
|
|
|
### Issues
|
|
Creating and discussing [Issues](https://github.com/poanetwork/tokenbridge/issues) provides significant value to the project. If you find a bug you can report it in an Issue.
|
|
|
|
### Pull Requests
|
|
All pull requests should include:
|
|
* A clear, readable description of the purpose of the PR
|
|
* A clear, readable description of changes
|
|
* Any additional concerns or comments (optional)
|