Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 2.04 KB
Raw

We're looking for contributors, help us improve Pluto. 😁

Hers's how you can help

  • Look for issues marked as help wanted.
  • Submit a new Plugin, see the guidelines.
  • While submitting a new PR,
    • make sure tests are all successful
    • if you think we need any new test, feel free to add new tests
    • please attach a reference video or image for the change

Prerequisite

In order to start contributing to Pluto, you need to fork the project and open it in Android Studio/IntelliJ IDEA.

Before committing we suggest you install the pre-commit hooks with the following command:

./gradlew installGitHook

This will make sure your code is validated against ktLint and detekt before every commit. The command will run automatically before the clean task, so you should have the pre-commit hook installed by then.

Before submitting a PR please run:

./gradlew build

This will build the library and make sure your CI checks will pass.

Before your code can be accepted into the project you must also sign the Individual Contributor License Agreement (CLA). You will be prompted to sign the agreement once you raise the pull request.