Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
138 lines (92 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

138 lines (92 loc) · 3.45 KB

Contribution

We would love feedback on our Roadmap and we welcome contributions to Plano! Whether you're fixing bugs, adding new features, improving documentation, or creating tutorials, your help is much appreciated.

How to Contribute

1. Fork the Repository

Fork the repository to create your own version of Plano:

  • Navigate to the Plano GitHub repository.
  • Click the "Fork" button in the upper right corner.
  • This will create a copy of the repository under your GitHub account.

2. Clone Your Fork

Once you've forked the repository, clone it to your local machine (replace <your-username> with your GitHub username):

git clone git@github.com:<your-username>/plano.git
cd plano

3. Add Upstream Remote

Add the original repository as an upstream remote so you can keep your fork in sync:

git remote add upstream git@github.com:katanemo/plano.git

To sync your fork with the latest changes from the main repository:

git fetch upstream
git checkout main
git merge upstream/main

4. Install Prerequisites

Install uv (Python package manager for the planoai CLI):

curl -LsSf https://astral.sh/uv/install.sh | sh

Install pre-commit hooks:

Pre-commit hooks help maintain code quality by running automated checks before each commit. Install them with:

pip install pre-commit
pre-commit install

The pre-commit hooks will automatically run:

  • YAML validation
  • Code formatting checks (Rust with cargo fmt, Python with black)
  • Linting checks (Rust with cargo clippy)
  • Rust unit tests

5. Setup the planoai CLI

The planoai CLI is used to build, run, and manage Plano locally:

cd cli
uv sync

This creates a virtual environment in .venv and installs all dependencies.

Now you can use planoai commands from anywhere, or use uv run planoai from the cli directory.

6. Create a Branch

Use a descriptive name for your branch (e.g., fix-bug-123, add-feature-x).

git checkout -b <your-branch-name>

7. Make Your Changes

Make your changes in the relevant files. If you're adding new features or fixing bugs, please include tests where applicable.

8. Test Your Changes Locally

Run Rust tests:

cd crates
cargo test

For library tests only:

cargo test --lib

Run Python CLI tests:

cd cli
uv run pytest

Or with verbose output:

uv run pytest -v

Run pre-commit checks manually:

Before committing, you can run all pre-commit checks manually:

pre-commit run --all-files

9. Push changes, and create a Pull request

Go back to the original Plano repository, and you should see a "Compare & pull request" button. Click that to submit a Pull Request (PR). In your PR description, clearly explain the changes you made and why they are necessary.

We will review your pull request and provide feedback. Once approved, your contribution will be merged into the main repository!

Contribution Guidelines

  • Ensure that all existing tests pass.
  • Write clear commit messages.
  • Add tests for any new functionality.
  • Follow the existing coding style (enforced by pre-commit hooks).
  • Update documentation as needed.
  • Pre-commit hooks must pass before committing.

To get in touch with us, please join our discord server. We will be monitoring that actively and offering support there.