Skip to content

docs: Adds instructions for dev environment setup to the Contributor guide. #309

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

Merged
nrfulton merged 2 commits into from
Jan 13, 2026
Merged

docs: Adds instructions for dev environment setup to the Contributor guide. #309

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0099b8
Adds common gotchas in the contributors setup section.
nrfulton Jan 13, 2026
d1cbf63
Merge branch 'main' into nathan/readme_devsetup
nrfulton Jan 13, 2026
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
22 changes: 22 additions & 0 deletions docs/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1392,6 +1392,28 @@ When using `SamplingStrategy`s or during validation, Mellea can speed up the exe

## Appendix: Contributing to Mellea

### Contributor Guide: Getting Started

If you are going to contribute to Mellea, it is important that you use our
pre-commit hooks. Using these hooks -- or running our test suite --
requires installing `[all]` optional dependencies and also the dev group.

```
git clone git@github.com:generative-computing/mellea.git &&
cd mellea &&
uv venv .venv &&
source .venv/bin/activate &&
uv pip install -e ".[all]" --group dev
pre-commit install
```

You can then run all tests by running `pytest`, or only the CI/CD tests by
running `CICD=1 pytest`.

Tip: you can bypass the hooks by passing the `-n` flag to `git commit`.
This is sometimes helpful for intermediate commits that you intend to later
squash.

### Contributor Guide: Requirements and Verifiers

Contributing new Requirements (i.e., verifiers) is an easy way to get started contributing to Mellea. Requirements can be as general or as domain-specific as you'd like, but must encapsulate a coherent and testable property. We have seen many examples of Requirements throughout this tutorial.
Expand Down