|
| 1 | +## How to Contribute |
| 2 | + |
| 3 | +Help from externals in whatever form is always more than welcome. You can start |
| 4 | +by just trying out the various products of the C++ codebase (our main focus |
| 5 | +is now on the language Solidity, the IDE Mix and the Ethereum node implementation |
| 6 | +eth). If something strange happens, please report an issue (see below). |
| 7 | +Once you get to know the technology, you can try to answer questions from |
| 8 | +other people (we do not always have time for that) either on [gitter](https://gitter.im/ethereum/cpp-ethereum), |
| 9 | +[stackexchange](http://ethereum.stackexchange.com/) or just comment on [issues](https://github.com/ethereum/webthree-umbrella/issues). |
| 10 | + |
| 11 | +If you know C++, you can help by submitting pull requests (see below). |
| 12 | +We try to keep a list of [good tasks to start with](https://github.com/ethereum/webthree-umbrella/labels/good%20first%20task). |
| 13 | +Please get in contact on gitter if you have any questions or suggestions. |
| 14 | + |
| 15 | +We keep backlogs of tasks in different sites, depending on the subproject: |
| 16 | + |
| 17 | + * [Solidity Backlog](https://www.pivotaltracker.com/n/projects/1189488) |
| 18 | + * [Mix Backlog](https://github.com/ethereum/mix/issues) |
| 19 | + * [Eth Backlog](https://www.pivotaltracker.com/n/projects/1510366) |
| 20 | + |
| 21 | + |
| 22 | +### How to Report Issues |
| 23 | + |
| 24 | +Please report issues to the project they appear in, either |
| 25 | +[Solidity](https://github.com/ethereum/solidity/issues), |
| 26 | +[Mix](https://github.com/ethereum/mix/issues) or |
| 27 | +[eth / anything else](https://github.com/ethereum/webthree-umbrella/issues). |
| 28 | + |
| 29 | +Try to mention which version of the software you used and on which platform (Windows, MacOS, Linux, ...), |
| 30 | +how you got into the situation (what did you do), what did you expect to happen |
| 31 | +and what actually happened. |
| 32 | + |
| 33 | +### How to Submit Pull Requests / Workflow |
| 34 | + |
| 35 | +Please see the [wiki](https://github.com/ethereum/webthree-umbrella/wiki) for how |
| 36 | +to set up your work environment and for build instructions. There, you can |
| 37 | +also find an [overview](https://github.com/ethereum/webthree-umbrella/wiki/Overview) |
| 38 | +of the various repositories and directories. |
| 39 | +Please also repect the [Coding Style](CodingStandards.txt). |
| 40 | + |
| 41 | +If you encounter any problems, please ask on gitter. |
| 42 | + |
| 43 | +If you are satisfied with your work and all tests pass, |
| 44 | +fork the sub-repository you want to change and register your fork |
| 45 | +as a remote in the sub-repository you recursively cloned from webthree-umbrella. |
| 46 | +Create pull requests against the `develop` branch of the repository you |
| 47 | +made changes in. Try not to include any merges with the pull request and rebase |
| 48 | +if necessary. If you can set labels on a pull request, set it to `please review` |
| 49 | +and also ask for a review in [gitter](http://gitter.im/ethereum/cpp-ethereum). |
| 50 | +You can also do reviews on others' pull requests. In this case either comment |
| 51 | +with "looks good" or set the label if you can. If at least one core developer |
| 52 | +apart from the author is confident about the change, it can be merged. |
| 53 | +If the reviewer thinks that corrections are necessary, they put he label `got issues`. |
| 54 | +If the author addressed all comments, they again put `please review` or comment |
| 55 | +appropriately. |
| 56 | + |
| 57 | +Our CI system will run tests against the subproject and notify about their satus on the pull request. |
| 58 | + |
| 59 | +Thanks for helping and have fun! |
0 commit comments