CONTRIBUTING.md

Contributing

Thanks for your interest in contributing to Composables CLI.

Kindly read this before opening a pull request. Keep changes focused, prefer the smallest fix that fully solves the problem, and verify your work before handing it off.

If you run into an issue and need help, reach out to Alex Styl on X.

Development

Fork this repo

You can fork this repo by clicking the Fork button in the top right corner or by clicking here.

Clone your fork in your local machine

git clone https://github.com/your-username/composables-cli.git

Navigate to the project directory

cd composables-cli

Create a new branch

git checkout -b my-new-branch

Running the CLI locally

./gradlew run --args="--help"

Testing

Before opening a pull request, run ./gradlew test to run all tests locally.

Ensure that all tests are passing locally before submitting a pull request. If you are adding new functionality, make sure to include tests for it.

Code formatting

We use spotless for code formatting. Make sure to run ./gradlew spotlessCheck to verify that your code is well formatted according to the project rules.

Use ./gradlew spotlessApply to fix any code formatting errors you spot.