2018-11-21 15:30:00 +00:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
Thank you for considering to help out with the source code! We welcome
|
|
|
|
|
contributions from anyone on the internet, and are grateful for even the
|
|
|
|
|
smallest of fixes!
|
|
|
|
|
|
|
|
|
|
If you'd like to contribute to go-ethereum, please fork, fix, commit and send a
|
|
|
|
|
pull request for the maintainers to review and merge into the main code base. If
|
|
|
|
|
you wish to submit more complex changes though, please check up with the core
|
|
|
|
|
devs first on [our gitter channel](https://gitter.im/ethereum/go-ethereum) to
|
|
|
|
|
ensure those changes are in line with the general philosophy of the project
|
|
|
|
|
and/or get some early feedback which can make both your efforts much lighter as
|
|
|
|
|
well as our review and merge procedures quick and simple.
|
|
|
|
|
|
|
|
|
|
## 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"
|
|
|
|
|
|
2018-01-29 19:44:18 +00:00
|
|
|
## Can I have feature X
|
|
|
|
|
|
2018-11-21 15:30:00 +00:00
|
|
|
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
|
|
|
|
|
[Wiki page](https://github.com/ethereum/go-ethereum/wiki) for more info
|
2018-01-29 19:44:18 +00:00
|
|
|
and help.
|
|
|
|
|
|
2018-11-21 15:30:00 +00:00
|
|
|
## Configuration, dependencies, and tests
|
2018-01-29 19:44:18 +00:00
|
|
|
|
2018-11-21 15:30:00 +00: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.
|
