Add Git workflow and update docs
This commit is contained in:
15
README.md
15
README.md
@@ -72,6 +72,14 @@ rp --version
|
||||
uv sync
|
||||
```
|
||||
|
||||
### Testing
|
||||
|
||||
```bash
|
||||
uv run pytest # Run all tests
|
||||
uv run pytest -v # Verbose output
|
||||
uv run pytest tests/test_detect.py # Single file
|
||||
```
|
||||
|
||||
### Linting & Type Checking
|
||||
|
||||
```bash
|
||||
@@ -86,6 +94,13 @@ uv run mypy src/
|
||||
uv build
|
||||
```
|
||||
|
||||
## Workflow
|
||||
|
||||
- `main` — stable release branch
|
||||
- `dev` — integration branch for day-to-day work
|
||||
- Short-lived branches: `feature/<topic>`, `fix/<topic>`, `docs/<topic>`
|
||||
- Open PRs into `dev` (squash merge); merge `dev` to `main` for releases
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
Reference in New Issue
Block a user