Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

32 lines (24 loc) · 1.98 KB
Raw

Contributing to Ethlint

Thanks for any and all contributions you make to this project!

Issues and Feature requests

For all bug reports, feature requests, lint rule suggestions and any other issues, use the Issue Tracker. For inquiries and general discussions, please head to the Gitter Channel.

To track the progress of Ethlint over time, see Projects.

Code

Any change that needs to be committed to this repository is a code change.

  • Almost all non-trivial code changes must be accompanied by tests.
  • Changes involving features, lint rules or utility methods for developers must be documented.
  • All major changes must have a corresponding entry in the Changelog file. See Keep a Changelog on how to create a good changelog entry.

Practices

  1. Checkout your branch from the develop branch and direct all Pull Requests to develop.
  2. Use ES6.
  3. Use const instead of let wherever possible.
  4. Avoid the pyramid style of closing braces at all cost.
  5. Make sure to both lint and test once you're done making all changes. See documentation on how to perform these.
  6. If proposing a change that hasn't already been discussed in an issue, please raise an associated issue first. For example, it is best to raise an issue for a Lint rule and discuss it with the developers first to avoid the possibility of waste of effort.

License

By making any code contributions to Ethlint, you agree that they will be licensed under the MIT License.

Donations

We currently accept the following payment methods:

  • ETH: 0xacc661A56af9793a4437876a52F4Ad3fc3C443d6

Bounty sponsorship

Please get in touch over our Gitter channel or shoot an email at [email protected].