Thanks for considering contributing to Solhint!
The following is a set of guidelines for contributions. Feel free to suggest improvements to this document in a pull request.
If you have any issues to report or features to request, please use the issue tracker.
In order to develop Solhint, you'll need:
Clone this repository and install npm dependencies:
$ git clone [email protected]:protofire/solhint.git
$ cd solhint
$ npm install
Since solhint
is a CLI tool, the best way to test new changes immediately
after they are done is to globally link the module. Go to the repository and
run:
$ npm link
This will create a symbolic link to solhint
's directory. Any changes you make
will be available when you use solhint
in any terminal.
If you make changes to the existing code, please make sure that all tests are passing. If you contribute with a new feature, please add tests for it. To run the tests:
$ npm test
All code changes happen through pull requests. To create one:
- Fork the repo and create your branch from
master
. - Make the changes you want to do.
- Ensure the tests are still passing. Please remember to add tests for new features.
- Create the pull request.
By contributing, you agree that your contributions will be licensed under its MIT License.