Contributing
Contributions are welcome. See how to set up a development environment, run tests, and add new integrations.
Contributing to reza
Thank you for your interest in contributing to reza.
Development Setup
git clone https://github.com/suwebreza/reza
cd reza
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install -e ".[dev]"Running Tests
pytest
pytest --cov=reza --cov-report=term-missingProject Structure
reza/
├── reza/
│ ├── cli.py # Click CLI — all user-facing commands
│ ├── schema.py # DB schema + connection utilities
│ ├── init_db.py # Project scanning and initialization
│ ├── watcher.py # Real-time file watcher (watchdog)
│ ├── session.py # Session CRUD
│ ├── query.py # Query functions
│ ├── update.py # File update for git hooks
│ └── export.py # Export to markdown / JSON
├── integrations/ # Tool-specific integration guides
├── tests/ # pytest test suite
├── pyproject.toml
└── README.md
Adding a Tool Integration
- Create
integrations/TOOLNAME/README.md - Cover at minimum:
- Setup steps
- How to inject context into the tool
- Cross-LLM handoff workflow (
reza sessioncommands) - Any tool-specific config files
- Add the tool to the table in
integrations/README.md - Add the tool to the main
README.mdintegrations table
Adding Purpose Extraction for a Language
In reza/init_db.py, the extract_purpose() function uses regex patterns.
To add a new language:
- Add the file extension to
TEXT_EXTENSIONS - Add a pattern to
extract_purpose()for that extension - Add a test case in
tests/test_init.py
Pull Request Guidelines
- Keep PRs focused — one feature or fix per PR
- Add tests for new functionality
- Run
pytestbefore submitting - Run
black reza/ tests/andruff check reza/ tests/for formatting
Publishing releases (maintainers)
Version is defined in reza/__init__.py, pyproject.toml, and npm/package.json (@swebreza/reza). Keep them in sync.
PyPI (pip)
pip install build twine
python -m build
python -m twine upload dist/reza-0.5.0-py3-none-any.whl dist/reza-0.5.0.tar.gzUse trusted publishing or API tokens; never commit secrets.
npm
cd npm
npm publish --access publicThe npm package is a thin installer: users still need the Python wheel from PyPI (pip install reza runs from postinstall).
Docs site (website/): run npm run build before deploy; content is mirrored from website/content/ (copy README.md and CHANGELOG.md from the repo root when they change).
Reporting Bugs
Open an issue at https://github.com/suwebreza/reza/issues with:
- Python version
- OS
reza --versionoutput- Steps to reproduce
- Expected vs actual behavior