Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 2.25 KB

CONTRIBUTING.adoc

File metadata and controls

57 lines (42 loc) · 2.25 KB
Raw

Keep Contribution Guide

🎉 Thanks for taking the time to contribute! 🎉 Contributions are welcome from anyone, and even the smallest of fixes is appreciated!

The following is a set of guidelines for contributing to Keep and its packages. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Getting started

  1. Fork keep-network/tbtc-v2

  2. Clone your fork

  3. Each module has their own setup instructions. Follow the README of the specific module you want to contribute to.

  4. Set up the Development Tooling.

  5. Open a PR against the main branch and describe the change you are intending to undertake in the PR description.

Before marking the PR as ready for review, make sure:

  • It passes the linter checks (see Pre-commit to make this automatic).

  • It passes the continuous integration tests.

  • Your changes have sufficient test coverage (e.g regression tests have been added for bug fixes, unit tests for new features)

Development Tooling

Commits must be signed.

Continuous Integration

Keep uses Github Actions for continuous integration. All jobs must be green to merge a PR.

Pre-commit

Pre-commit is a tool to install hooks that check code before commits are made. It can be helpful to install this, to automatically run linter checks and avoid pushing code that will not be accepted. Follow the installation instructions here, and then run pre-commit install to install the hooks.

Linting

Linters and formatters for Solidity, JavaScript, and Go code are set up and run automatically as part of pre-commit hooks. These are checked again in CI builds to ensure they have been run and are passing.

If you want to change a rule, or add a custom rule, to the JavaScript or Solidity linting, please propose these changes to our solium-config-keep and eslint-config-keep packages. All other packages have it as a dependency.