CONTRIBUTING.md

🤝 Contributing to FastAPI-Cap

Thank you for your interest in contributing to FastAPI-Cap!
We welcome bug reports, feature requests, documentation improvements, and code contributions.

---

🛠️ Development Setup

1. Fork & Clone the Repository

git clone https://github.com/your-username/fastapi-cap.git
cd fastapicap

2. Install Development Dependencies

We recommend using uv for fast, modern Python dependency management, but you can also use pip.

Using uv (recommended)

uv sync --dev

Or, install manually with pip

pip install \
    httpx>=0.28.1 \
    mkdocs-material>=9.6.14 \
    mkdocstrings[python]>=0.29.1 \
    pytest>=8.4.1 \
    pytest-asyncio>=1.0.0 \
    pytest-xdist>=3.7.0 \
    testcontainers>=4.10.0

---

🧪 Running Tests

Make sure you have a docker running as the unit test will create test container:

Then run the test suite:

pytest

You can also run tests in parallel for faster feedback:

pytest -n auto

---

📝 Code Style

• Please follow PEP8 and use Ruff for formatting.
• Type hints are required for all new code.

---

📚 Documentation

• Documentation is built with MkDocs Material.
• To serve the docs locally:

mkdocs serve

---

🙏 Thank You

Your contributions make FastAPI-Cap better for everyone!
If you have any questions, open an issue or start a discussion.

---