Skip to content

Commit fc46e53

Browse files
committed
chore: add CONTRIBUTING.md
1 parent 0bf1154 commit fc46e53

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contributing
2+
3+
1. Fork the repo
4+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
5+
3. Install dev dependencies: `pip install -r requirements.txt`
6+
4. Make changes with tests
7+
5. Run checks: `ruff check . --fix && ruff format . && pytest`
8+
6. Commit with conventional format: `feat(scope): description`
9+
7. Push and open a PR
10+
11+
## Code Standards
12+
13+
- Type hints on all public functions
14+
- `ruff` for linting and formatting
15+
- `pytest` for testing
16+
- No `print()` — use `logging.getLogger(__name__)`

0 commit comments

Comments
 (0)