Thanks for taking the time to help out and improve eth-cli! 🎉
The following is a set of guidelines for eth-cli contributions and may change over time. Feel free to suggest improvements to this document in a pull request!
All contributions are welcome!
If you run into an issue, the first step is to report a problem or to suggest a new feature, open a GitHub Issue. This will help the eth-cli maintainers become aware of the problem and prioritize a fix.
For code contributions, for either new features or bug fixes, see Development.
If you're looking to make a substantial change, you may want to reach out first to give us a heads up.
This repository (protofire/eth-cli) is a collection of CLI tools to help with ethereum learning and development.
In order to develop eth-cli, you'll need:
First clone this repository and install NPM dependencies:
$ git clone git@github.com:protofire/eth-cli.git
$ cd eth-cli
$ npm install
Community contributions to eth-cli require that you first fork the
repository you are modifying. After your modifications, push changes to your fork and submit a pull request upstream to eth-cli's fork(s).
See GitHub documentation about Collaborating with issues and pull requests for more information.
❗ Note: eth-cli development uses a long-lived
masterbranch for new (non-hotfix) development. Pull Requests should be opened againstmasterin all repositories.
eth-cli project maintains one stable branch:
master, for latest full releases and work targeting a patch release
Use a branch for your modifications, tracking it on your fork:
$ git checkout -b feature/sweet-feature
$ git push --set-upstream origin feature/sweet-feature
Then, make changes and commit as usual.
Some things that will increase the chance that your pull request is accepted:
- Write tests.
- Write a good commit message.
Thanks again for all your support, encouragement, and effort! eth-cli would not be possible without contributors like you. 🙇