# Contributing

Thanks for your interest in `agent-workflow-mcp`. Every PR helps.

## Setup

```bash
git clone https://github.com/tai-nguyen/agent-workflow-mcp.git
cd agent-workflow-mcp
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pre-commit install
```

## Workflow

1. Branch off `main`: `git checkout -b feat/short-slug`
2. Run `make check` (lint + type + tests)
3. Add a test for any new behavior
4. Update `CHANGELOG.md` under the `Unreleased` heading
5. Open a PR with the template; reference any related issue

## Conventions

- Code style: `black` (line length 100), `isort`, `ruff`.
- Type hints everywhere. No `Any` in public APIs.
- Docstrings on every public function and class.
- No comments in code. Names carry meaning. If a branch needs a comment, refactor.
- Conventional commits: `feat:`, `fix:`, `refactor:`, `docs:`, `test:`, `chore:`.

## Reporting bugs

Open an issue with the smallest reproducer you can manage. Include `agent-workflow-mcp --version` and the relevant `trace` tree.

## Security

Please email `tai@example.dev` instead of filing a public issue for security reports.