Skip to content

Commit 38bb189

Browse files
committed
Add contribution guide
1 parent 1cd9607 commit 38bb189

2 files changed

Lines changed: 34 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing
2+
3+
## Development Setup
4+
5+
1. Fork and clone the repository.
6+
2. Create a virtual environment.
7+
3. Install the project in editable mode.
8+
9+
```bash
10+
python3 -m venv .venv
11+
source .venv/bin/activate
12+
python -m pip install -e .
13+
```
14+
15+
## Running Tests
16+
17+
Run the test suite before opening a pull request.
18+
19+
```bash
20+
python -m unittest discover -s tests
21+
```
22+
23+
## Pull Requests
24+
25+
1. Keep changes focused and minimal.
26+
2. Add or update tests when behavior changes.
27+
3. Update documentation when user-facing behavior changes.
28+
4. Open a pull request with a clear description of the change.
29+
30+
## Notes
31+
32+
- CI runs automatically for pull requests.
33+
- Markdown-only changes do not trigger the test workflow.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,7 @@ PYTHONPATH=src python3 -m jenga.cli account-balance --country-code KE --account-
199199
- This package currently focuses on a small subset of Jenga APIs.
200200
- The README only documents endpoints that are actually implemented in this repository.
201201
- Pending endpoints are listed for roadmap visibility only.
202+
- See the [contribution guide](./CONTRIBUTING.md) for development and pull request workflow.
202203

203204
## 7. License
204205
License: [MIT](./LICENSE)

0 commit comments

Comments
 (0)