lamhieu/docsifer

1# Contributing2 3Thanks for your interest in Docsifer.4 5## Development setup6 7```bash8git clone https://github.com/lh0x00/docsifer.git9cd docsifer10make install11cp .env.example .env12make run13```14 15Hop into <http://localhost:7860/docs> for the OpenAPI docs.16 17## Style18 19We use:20 21- **ruff** for linting and formatting (`make lint` / `make format`).22- **mypy** for type checking (`make type`).23- **pytest** + **pytest-asyncio** for tests (`make test`).24 25Pre-commit hooks are configured in `.pre-commit-config.yaml`. Install them26with `pre-commit install` to catch issues before pushing.27 28## Pull requests29 301. Branch from `main`.312. Add tests for any new behavior — see `tests/unit` and `tests/integration`.323. Make sure `make lint test` passes locally.334. Update `README.md` / `ARCHITECTURE.md` when you change behavior.34 35## Bug reports36 37Please include:38 39- Docsifer version (`docsifer/__init__.py:__version__`).40- Python and OS versions.41- A minimal reproduction (curl command or test snippet).42- Logs (with `DOCSIFER_LOG_JSON=false` for readability).43