Skip to content

Commit 6287634

Browse files
docs: CONTRIBUTING for uv/Typer/PyPI
Closes #53 Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 0f7f1a7 commit 6287634

1 file changed

Lines changed: 26 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1-
# Fixtures
1+
# Contributing to Create Awesome Python App
22

3-
Local stub templates live under `fixtures/` for CI `file://` scaffolding tests.
3+
Thanks for contributing! Please follow the [Code of Conduct](./.github/CODE_OF_CONDUCT.md).
4+
5+
## Local development
6+
7+
```bash
8+
git clone https://github.com/Create-Python-App/create-python-app.git
9+
cd create-python-app
10+
uv sync --group dev
11+
uv run pre-commit install
12+
make test
13+
make lint
14+
make typecheck
15+
```
16+
17+
## Pull requests
18+
19+
1. Branch from `main`
20+
2. Keep changes focused; link an issue
21+
3. Use [Conventional Commits](https://www.conventionalcommits.org/)
22+
4. Ensure tests/lint/typecheck pass
23+
5. Fill out the PR template
24+
25+
## Templates
26+
27+
Template bank work will live in `cpa-templates` (tracked in #44). Until then use `fixtures/`.

0 commit comments

Comments
 (0)