Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

92 lines (61 loc) · 3.02 KB
Raw

Contributing to Solhint

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.

Issues and feature requests

If you have any issues to report or features to request, please use the issue tracker.

Roadmap

There's a (tentative) roadmap in which we've put down what we envision to be the best-next functionalities.

Since the project is constantly evolving and new features are requested/discovered as we go, this roadmap is open for discussions and we expect it to change over time.

Roadmap-wise contributions via new issues are always welcomed.

Development

Requirements

In order to develop Solhint, you'll need:

Getting Started

Clone this repository and install npm dependencies:

$ git clone [email protected]:protofire/solhint.git
$ cd solhint
$ npm install

Testing changes without re-installing

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.

Running tests

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

Grammar modifications

Solhint uses ANTLR4 to generate the Solidity parser. The grammar description is taken from solidity-antlr4. If there is some language feature that Solhint doesn't support, the first step is to check if the Solidity.g4 fil is out of sync with the one in that repo. If that's the case, the steps to update it are:

  1. Copy the Solidity.g4 file and replace the one in this repo (lib/grammar/Solidity.g4).
  2. From the root of the project, execute scripts/build-grammar.sh. You will need to have the Java Runtime Environment (7 or later) installed for this to work.

Pull Requests

All code changes happen through pull requests. To create one:

  1. Fork the repo and create your branch from master.
  2. Make the changes you want to do.
  3. Ensure the tests are still passing. Please remember to add tests for new features.
  4. Create the pull request.

Considerations

  • It is highly encouraged to follow The seven rules of a great Git commit message
  • Code should be self-documented. But, in case there is any code that may be hard to understand, it must include some comments to make it easier to review and maintain later on.

License

By contributing, you agree that your contributions will be licensed under its MIT License.