2019-02-26 01:43:10 -08:00
|
|
|
# Contributing
|
2018-05-23 22:32:26 -07:00
|
|
|
|
2019-02-26 01:43:10 -08:00
|
|
|
Thank you for your interest in contributing to Quorum!
|
|
|
|
|
We welcome contributions from anyone on the internet, and are grateful for even the
|
|
|
|
|
smallest of fixes!
|
2017-02-03 13:37:37 -08:00
|
|
|
|
2019-02-26 22:03:53 -08:00
|
|
|
If you'd like to contribute to quorum please fork, fix, commit and
|
2018-05-23 22:32:26 -07:00
|
|
|
send a pull request. Commits which do not comply with the coding standards
|
2019-02-26 01:43:10 -08:00
|
|
|
are ignored.
|
|
|
|
|
|
|
|
|
|
## Coding guidelines
|
|
|
|
|
|
|
|
|
|
Please make sure your contributions adhere to our coding guidelines:
|
|
|
|
|
|
|
|
|
|
* Code must adhere to the official Go
|
|
|
|
|
[formatting](https://golang.org/doc/effective_go.html#formatting) guidelines
|
|
|
|
|
(i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
|
|
|
|
|
* Code must be documented adhering to the official Go
|
|
|
|
|
[commentary](https://golang.org/doc/effective_go.html#commentary) guidelines.
|
|
|
|
|
* Pull requests need to be based on and opened against the `master` branch.
|
|
|
|
|
* Commit messages should be prefixed with the package(s) they modify.
|
|
|
|
|
* E.g. "eth, rpc: make trace configs optional"
|
|
|
|
|
|
|
|
|
|
## Can I have feature X
|
|
|
|
|
|
|
|
|
|
Before you submit a feature request, please check and make sure that it isn't
|
|
|
|
|
possible through some other means. The JavaScript-enabled console is a powerful
|
|
|
|
|
feature in the right hands. Please check our
|
2019-02-26 22:03:53 -08:00
|
|
|
[Wiki page](https://github.com/jpmorganchase/quorum/wiki) for more info
|
2019-02-26 01:43:10 -08:00
|
|
|
and help.
|
|
|
|
|
|
|
|
|
|
## Configuration, dependencies, and tests
|
2018-05-23 22:32:26 -07:00
|
|
|
|
2019-02-26 01:43:10 -08:00
|
|
|
Please see the [Developers' Guide](https://github.com/ethereum/go-ethereum/wiki/Developers'-Guide)
|
|
|
|
|
for more details on configuring your environment, managing project dependencies
|
|
|
|
|
and testing procedures.
|
