From 187828b703ac096edb7c7c0f905339948654fb92 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20M=C3=BCllner?= Date: Fri, 6 Mar 2026 06:43:58 +0100 Subject: [PATCH] docs: align README with existing license/docs and expand commit message guide --- CONTRIBUTING.md | 28 +++++++++++++++++++++++++--- README.md | 9 ++++++--- 2 files changed, 31 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4c7e38..0ab4c4e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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` diff --git a/README.md b/README.md index 9363f30..09e40a1 100644 --- a/README.md +++ b/README.md @@ -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` +