|
1 | 1 | # Contributing
|
2 | 2 |
|
3 |
| -Thank you for considering to help out with the source code! We welcome |
4 |
| -contributions from anyone on the internet, and are grateful for even the |
| 3 | +Thank you for your interest in contributing to GoQuorum! |
| 4 | + |
| 5 | +We welcome contributions from anyone on the internet, and are grateful for even the |
5 | 6 | smallest of fixes!
|
6 | 7 |
|
7 |
| -If you'd like to contribute to go-ethereum, please fork, fix, commit and send a |
8 |
| -pull request for the maintainers to review and merge into the main code base. If |
9 |
| -you wish to submit more complex changes though, please check up with the core |
10 |
| -devs first on [our gitter channel](https://gitter.im/ethereum/go-ethereum) to |
11 |
| -ensure those changes are in line with the general philosophy of the project |
12 |
| -and/or get some early feedback which can make both your efforts much lighter as |
13 |
| -well as our review and merge procedures quick and simple. |
| 8 | +If you'd like to contribute to quorum please fork, fix, commit and |
| 9 | +send a pull request. Commits which do not comply with the coding standards |
| 10 | +are ignored. |
14 | 11 |
|
15 | 12 | ## Coding guidelines
|
16 | 13 |
|
17 | 14 | Please make sure your contributions adhere to our coding guidelines:
|
18 | 15 |
|
19 |
| - * Code must adhere to the official Go |
20 |
| -[formatting](https://golang.org/doc/effective_go.html#formatting) guidelines |
| 16 | + * Code must adhere to the official Go |
| 17 | +[formatting](https://golang.org/doc/effective_go.html#formatting) guidelines |
21 | 18 | (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
|
22 |
| - * Code must be documented adhering to the official Go |
| 19 | + * Code must be documented adhering to the official Go |
23 | 20 | [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines.
|
24 | 21 | * Pull requests need to be based on and opened against the `master` branch.
|
25 | 22 | * Commit messages should be prefixed with the package(s) they modify.
|
26 | 23 | * E.g. "eth, rpc: make trace configs optional"
|
27 | 24 |
|
28 | 25 | ## Can I have feature X
|
29 | 26 |
|
30 |
| -Before you submit a feature request, please check and make sure that it isn't |
31 |
| -possible through some other means. The JavaScript-enabled console is a powerful |
32 |
| -feature in the right hands. Please check our |
33 |
| -[Geth documentation page](https://geth.ethereum.org/docs/) for more info |
| 27 | +Before you submit a feature request, please check and make sure that it isn't |
| 28 | +possible through some other means. The JavaScript-enabled console is a powerful |
| 29 | +feature in the right hands. Please check our |
| 30 | +[developer documentation](https://docs.goquorum.consensys.net/en/latest/) for more info |
34 | 31 | and help.
|
35 | 32 |
|
36 | 33 | ## Configuration, dependencies, and tests
|
37 | 34 |
|
38 | 35 | Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers/devguide)
|
39 | 36 | for more details on configuring your environment, managing project dependencies
|
40 | 37 | and testing procedures.
|
| 38 | + |
| 39 | +## Issue reproductibility |
| 40 | + |
| 41 | +Before you create an issue, please try to reproduce it with [quorum quick dev start framework](https://github.com/ConsenSys/quorum-dev-quickstart) with the latest release. |
| 42 | +Many issues have been creating under an environment we are not able to reproduce quickly. |
0 commit comments