Skip to content

docs: rewrite CONTRIBUTING.md for the Rust CLI (fixes #12) #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
NePreby wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: rewrite CONTRIBUTING.md for the Rust CLI (fixes #12) #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
260 changes: 49 additions & 211 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,241 +1,79 @@
# Contributing to Hanzo CLI

# Contributing to the Project
Thank you for your interest in contributing to the Hanzo CLI! This document outlines the process for developing, testing, and submitting contributions to the project.

We welcome contributions in the form of bug reports, feature requests,
and pull requests (PRs). This document describes how you can
contribute.
## Development Setup

## Bug Reports and Feature Requests

Please submit bug reports and feature requests as GitHub issues. This
helps us to keep track of them and discuss potential solutions or
enhancements.

## LLM Benchmark Results

Contributions of
[LLM benchmark results](https://dev.chat/docs/leaderboards/)
are welcome!
See the
[benchmark README](https://github.com/Dev-AI/dev/blob/main/benchmark/README.md)
for information on running dev's code editing benchmarks.
Submit results by opening a PR with edits to the
[benchmark results data files](https://github.com/Dev-AI/dev/blob/main/dev/website/_data/).


## Pull Requests

We appreciate your pull requests. For small changes, feel free to
submit a PR directly. If you are considering a large or significant
change, please discuss it in a GitHub issue before submitting the
PR. This will save both you and the maintainers time, and it helps to
ensure that your contributions can be integrated smoothly.

## Licensing

Before contributing a PR, please review our
[Individual Contributor License Agreement](https://dev.chat/docs/legal/contributor-agreement.html).
All contributors will be asked to complete the agreement as part of the PR process.

## Setting up a Development Environment
The Hanzo CLI is written in Rust. Make sure you have a modern Rust toolchain installed (stable edition 2021 or newer) via [rustup](https://rustup.rs/).

### Clone the Repository

```bash
git clone https://github.com/hanzoai/cli.git
cd cli
```
git clone https://github.com/Dev-AI/dev.git
cd dev
```

### Create a Virtual Environment

It is recommended to create a virtual environment outside of the repository to keep your development environment isolated.

#### Using `venv` (Python 3.9 and later)

```
python -m venv /path/to/venv
```

### Activate the Virtual Environment

#### On Windows

```
/path/to/venv/Scripts/activate
```

#### On Unix or macOS

```
source /path/to/venv/bin/activate
```

### Install the Project in Editable Mode

This step allows you to make changes to the source code and have them take effect immediately without reinstalling the package.

```
pip install -e .
```

### Install the Project Dependencies

```
pip install -r requirements.txt
```

For development, at least install the development dependencies:

```
pip install -r requirements/requirements-dev.txt
```

Consider installing other optional dependencies from the `requirements/` directory, if your development work needs them.

Note that these dependency files are generated by `./scripts/pip-compile.sh` and then committed. See [Managing Dependencies](#managing-dependencies).

### Install Pre-commit Hooks (Optional)

The project uses pre-commit hooks for code formatting and linting. If you want to install and use these hooks, run:

```
pre-commit install
```

This will automatically run the pre-commit hooks when you commit changes to the repository.

Now you should have a fully functional development environment for the Dev project. You can start making changes, running tests, and contributing to the project.

### Handy Opinionated Setup Commands for MacOS / Linux

Here's an example of following the setup instructions above, for your copy/paste pleasure if your system works the same. Start in the project directory.

```
python3 -m venv ../dev_venv \
&& source ../dev_venv/bin/activate \
&& pip3 install -e . \
&& pip3 install -r requirements.txt \
&& pip3 install -r requirements/requirements-dev.txt
```

### Running Tests

Just run `pytest`.

### Building the Docker Image
### Build from Source

The project includes a `Dockerfile` for building a Docker image. You can build the image by running:
Compile the binary in debug mode:

```bash
cargo build
```
docker build -t dev -f docker/Dockerfile .
```

### Building the Documentation

The project's documentation is built using Jekyll and hosted on GitHub Pages. To build the documentation locally, follow these steps:

1. Install Ruby and Bundler (if not already installed).
2. Navigate to the `dev/website` directory.
3. Install the required gems:
```
bundle install
```
4. Build the documentation:
```
bundle exec jekyll build
```
5. Preview the website while editing (optional):
```
bundle exec jekyll serve
```

The built documentation will be available in the `dev/website/_site` directory.

## Coding Standards

### Python Compatibility

Dev supports Python versions 3.9, 3.10, 3.11, and 3.12. When contributing code, ensure compatibility with these supported Python versions.

### Code Style

The project follows the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide for Python code, with a maximum line length of 100 characters. Additionally, the project uses [isort](https://pycqa.github.io/isort/) and [Black](https://black.readthedocs.io/en/stable/) for sorting imports and code formatting, respectively. Please install the pre-commit hooks to automatically format your code before committing changes.

### No Type Hints

The project does not use type hints.

### Testing

The project uses [pytest](https://docs.pytest.org/en/latest/) for running unit tests. The test files are located in the `dev/tests` directory and follow the naming convention `test_*.py`.

#### Running Tests
Or build an optimized release binary:

To run the entire test suite, use the following command from the project root directory:

```
pytest
```bash
cargo build --release
```

You can also run specific test files or test cases by providing the file path or test name:
Run the binary locally:

```bash
cargo run --bin hanzo -- --help
```
pytest tests/basic/test_coder.py
pytest tests/basic/test_coder.py::TestCoder::test_specific_case
```

#### Continuous Integration

The project uses GitHub Actions for continuous integration. The testing workflows are defined in the following files:

- `.github/workflows/ubuntu-tests.yml`: Runs tests on Ubuntu for Python versions 3.9 through 3.12.
- `.github/workflows/windows-tests.yml`: Runs that on Windows

These workflows are triggered on push and pull request events to the `main` branch, ignoring changes to the `dev/website/**` and `README.md` files.

#### Docker Build and Test

The `.github/workflows/docker-build-test.yml` workflow is used to build a Docker image for the project on every push or pull request event to the `main` branch. It checks out the code, sets up Docker, logs in to DockerHub, and then builds the Docker image without pushing it to the registry.

#### Writing Tests

When contributing new features or making changes to existing code, ensure that you write appropriate tests to maintain code coverage. Follow the existing patterns and naming conventions used in the `dev/tests` directory.

If you need to mock or create test data, consider adding it to the test files or creating separate fixtures or utility functions within the `dev/tests` directory.
## Running Tests

#### Test Requirements
Tests are organized into unit tests alongside source code and integration tests in `tests/`:

The project uses `pytest` as the testing framework, which is installed as a development dependency. To install the development dependencies, run the following command:
- Run all unit and integration tests:
```bash
cargo test
```

```
pip install -r requirements-dev.txt
```
- Run integration tests with isolated state:
```bash
cargo test --test cli
```

### Managing Dependencies
- Run a specific test case:
```bash
cargo test <test_name>
```

When introducing new dependencies, make sure to add them to the appropriate `requirements.in` file (e.g., `requirements.in` for main dependencies, `requirements-dev.in` for development dependencies). Then, run the following commands to update the corresponding `requirements.txt` file:
## Code Quality and Style

```
pip install pip-tools
./scripts/pip-compile.sh
```
Before creating a pull request, ensure your code passes linting and formatting checks:

You can also pass one argument to `pip-compile.sh`, which will flow through to `pip-compile`. For example:
- Run Clippy:
```bash
cargo clippy --bin hanzo
```

```
./scripts/pip-compile.sh --upgrade
```
- Check code formatting:
```bash
cargo fmt --check
```

### Pre-commit Hooks

The project uses [pre-commit](https://pre-commit.com/) hooks to automatically format code, lint, and run other checks before committing changes. After cloning the repository, run the following command to set up the pre-commit hooks:

```
pre-commit install
To automatically format your code according to style conventions:
```bash
cargo fmt
```

pre-commit will then run automatically on each `git commit` command. You can use the following command line to run pre-commit manually:
## Pull Request Guidelines

```
pre-commit run --all-files
```
1. **Branching:** Create a descriptive branch from `main` (e.g., `git checkout -b feat/my-feature` or `fix/issue-123`).
2. **Commit Messages:** Write concise, imperative commit messages describing the change and why it was made.
3. **Link Issues:** Reference relevant issues in your PR description (e.g., `Fixes #12`).
4. **CI Checks:** Ensure local builds and tests pass cleanly before pushing.