docs: align README with existing license/docs and expand commit message guide

This commit is contained in:
Lukas Müllner 2026-03-06 06:43:58 +01:00
parent e4f0f73fe8
commit 187828b703
2 changed files with 31 additions and 6 deletions

View file

@ -47,6 +47,28 @@ Before opening a PR:
## Commit Message Examples
- `fix(scanner): prevent duplicate processing on repeated detections`
- `perf(collections): coalesce overlapping reload requests`
- `docs(readme): add release workflow section`
Preferred format:
```text
type(scope): short summary
```
Common types used in this repository:
- `feat`: new feature
- `fix`: bug fix
- `perf`: performance improvement
- `docs`: documentation-only change
- `refactor`: code cleanup without behavior change
- `test`: tests added/updated
- `chore`: maintenance/tooling/config updates
Examples:
- `feat(scanner): add adaptive cooldown for repeated OCR misses`
- `fix(garage): prevent duplicate copy into target collection`
- `perf(collections): coalesce overlapping refresh requests`
- `docs(readme): add VS Code release build task usage`
- `refactor(auth): simplify session guard flow in AuthGate`
- `test(utils): cover scanner id extraction edge cases`
- `chore(vscode): add release build tasks for apk and appbundle`

View file

@ -173,7 +173,7 @@ Use **Terminal → Run Task**:
## Contributing
See `CONTRIBUTING.md` for branching, commit style, and PR guidelines.
See `CONTRIBUTING.md` for branching strategy, commit message rules, and PR guidelines.
## Security Notes
@ -185,9 +185,12 @@ For reporting vulnerabilities, see `SECURITY.md`.
## License
License file is not included in this repository yet.
Add your preferred license in the GitHub repo when ready.
This project is licensed under the MIT License.
See `LICENSE` for details.
## Reference
- Contributor guidelines: `CONTRIBUTING.md`
- Security policy: `SECURITY.md`
- Product/backend notes: `TPB.md`