Skip to content

Commit e493140

Browse files
committed
Add CONTRIBUTING.md
1 parent b5592ad commit e493140

1 file changed

Lines changed: 84 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# 🤝 Contributing to FastAPI-Cap
2+
3+
Thank you for your interest in contributing to **FastAPI-Cap**!
4+
We welcome bug reports, feature requests, documentation improvements, and code contributions.
5+
6+
---
7+
8+
## 🛠️ Development Setup
9+
10+
### 1. Fork & Clone the Repository
11+
12+
```bash
13+
git clone https://github.com/your-username/fastapi-cap.git
14+
cd fastapicap
15+
```
16+
17+
### 2. Install Development Dependencies
18+
19+
We recommend using [uv](https://github.com/astral-sh/uv) for fast, modern Python dependency management, but you can also use `pip`.
20+
21+
#### Using uv (recommended)
22+
23+
```bash
24+
uv sync --dev
25+
```
26+
27+
#### Or, install manually with pip
28+
29+
```bash
30+
pip install \
31+
httpx>=0.28.1 \
32+
mkdocs-material>=9.6.14 \
33+
mkdocstrings[python]>=0.29.1 \
34+
pytest>=8.4.1 \
35+
pytest-asyncio>=1.0.0 \
36+
pytest-xdist>=3.7.0 \
37+
testcontainers>=4.10.0
38+
```
39+
40+
---
41+
42+
## 🧪 Running Tests
43+
44+
Make sure you have a docker running as the unit test will create test container:
45+
46+
47+
_Then run the test suite:_
48+
49+
```bash
50+
pytest
51+
```
52+
53+
You can also run tests in parallel for faster feedback:
54+
55+
```bash
56+
pytest -n auto
57+
```
58+
59+
---
60+
61+
## 📝 Code Style
62+
63+
- Please follow [PEP8](https://www.python.org/dev/peps/pep-0008/) and use Ruff for formatting.
64+
- Type hints are required for all new code.
65+
66+
---
67+
68+
## 📚 Documentation
69+
70+
- Documentation is built with [MkDocs Material](https://squidfunk.github.io/mkdocs-material/).
71+
- To serve the docs locally:
72+
73+
```bash
74+
mkdocs serve
75+
```
76+
77+
---
78+
79+
## 🙏 Thank You
80+
81+
Your contributions make FastAPI-Cap better for everyone!
82+
If you have any questions, open an issue or start a discussion.
83+
84+
---

0 commit comments

Comments
 (0)