diff --git a/.github/ISSUE_TEMPLATE/1-bug.yml b/.github/ISSUE_TEMPLATE/1-bug.yml index 6d94627..529a02a 100644 --- a/.github/ISSUE_TEMPLATE/1-bug.yml +++ b/.github/ISSUE_TEMPLATE/1-bug.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: value: | - **Never include real people's names, a PIN, a key or a token** — not in text, not in a + **Never include real people's names, a PIN, a key or a token** – not in text, not in a screenshot, not in a log excerpt. Replace them with placeholders. A security vulnerability does not belong here. Use the Security tab, as described in diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index cd73f90..69757e6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -18,8 +18,8 @@ Inside a stack, title each layer `[n/N] type(scope): summary` and list the stack - [ ] `npm run typecheck && npm run typecheck:api && npm run lint && npm test && npm run build`, from the repo root -- [ ] `scripts/test-migrations.sh` — or not applicable, no SQL changed -- [ ] Checked in a browser or on the tablet — or not applicable, nothing visible changed +- [ ] `scripts/test-migrations.sh` – or not applicable, no SQL changed +- [ ] Checked in a browser or on the tablet – or not applicable, nothing visible changed ## Database @@ -32,11 +32,11 @@ Inside a stack, title each layer `[n/N] type(scope): summary` and list the stack ## Checks -- [ ] `CHANGELOG.md` updated under `[Unreleased]` — or not applicable, nothing user-visible +- [ ] `CHANGELOG.md` updated under `[Unreleased]` – or not applicable, nothing user-visible - [ ] No secret, PIN, key or token in the diff, the description or a screenshot - [ ] No real member names in fixtures, tests or screenshots - [ ] Branch name, commits and title follow the conventions in `CONTRIBUTING.md` ## Anything a reviewer should look at first - + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c87cb63..15346f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ wins where it is more specific. ## Before you write code -**Open an issue first** for anything beyond a typo. Not bureaucracy — this project has a live +**Open an issue first** for anything beyond a typo. Not bureaucracy – this project has a live campus deployment and a narrow scope, so the useful conversation is usually about whether a change belongs here at all, and that conversation is cheaper before the work than after it. @@ -18,7 +18,7 @@ Pull requests changing these will be declined, however well made: - **No login for the member-facing flow.** Zero friction is the product. An account is the thing that stops it being used. -- **No payment processing** — card, SEPA debit or online payment. +- **No payment processing** – card, SEPA debit or online payment. - **Nothing is deleted.** Months are archived; archives are kept indefinitely. - **Migrations are the only path to a schema change.** No editing schema in a dashboard, ever. - **German-first UI copy.** English for developer-facing labels and code comments. @@ -48,7 +48,7 @@ changelog entries. ## Stacked pull requests -For a change large enough to review in layers, use `gh stack` — `init`, `add`, `submit`, and +For a change large enough to review in layers, use `gh stack` – `init`, `add`, `submit`, and `gh stack merge` for an atomic all-or-nothing merge. Do not hand-build a stack out of `gh pr create --base`, and note that a stack has its own number, which is not a pull request number. @@ -109,7 +109,7 @@ And when SQL changed: scripts/test-migrations.sh ``` -These repositories are npm workspaces — `npm ci` runs at the root, never in a sub-package. +These repositories are npm workspaces – `npm ci` runs at the root, never in a sub-package. Add a `CHANGELOG.md` entry under `[Unreleased]` for anything user-visible. Internal refactors and CI tweaks do not need one. @@ -140,7 +140,7 @@ Only the founders merge to `main`. ## Secrets -Never commit one. Never paste one into an issue, a pull request or a comment — including in a +Never commit one. Never paste one into an issue, a pull request or a comment – including in a screenshot or a log excerpt, which is the usual way it happens. If you think you have exposed one, say so immediately; rotating a key is a small job and finding out late is not. diff --git a/README.md b/README.md index a81047e..0bb75f4 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ holds no application code. | Path | What it does | |---|---| | `profile/README.md` | The organisation's public profile page. | -| `brand/BRAND.md` | **The brand book** — wordmark, logo, palette, the visual world and the system that generates it. | +| `brand/BRAND.md` | **The brand book** – wordmark, logo, palette, the visual world and the system that generates it. | | `brand/logo/` | Logo and mark SVGs, palette variants, and the 512×512 avatar. | -| `brand/plates/` | The approved plate behind each surface, drawn at that surface's own size, plus kept plates nothing ships from — `readme-filter.png`, the fluted fan that was the README banner until 6 November 2026, and `wide.png`. Both are kept on purpose; nothing cutting from a plate is not a reason to drop it. | +| `brand/plates/` | The approved plate behind each surface, drawn at that surface's own size, plus kept plates nothing ships from – `readme-filter.png`, the fluted fan that was the README banner until 6 November 2026, and `wide.png`. Both are kept on purpose; nothing cutting from a plate is not a reason to drop it. | | `brand/assets/` | Every shipped surface: social previews, banners, square, story, print. | | `SECURITY.md` | How to report a vulnerability. Applies to every repository. | | `CONTRIBUTING.md` | Conventions, the gates, and the decisions that are deliberate. | @@ -29,5 +29,5 @@ Images are referenced by absolute `raw.githubusercontent.com` URL inside a ` +Kaffeelisten – die Kaffeeliste, ohne Papier # Kaffeelisten **The paper coffee list, without the paper.** A shared tablet stands by the coffee machine. You tap your company, tap your name, tap what you -took, and confirm. The screen resets itself. No login, no account, nothing to install — the whole +took, and confirm. The screen resets itself. No login, no account, nothing to install – the whole thing takes a few seconds, which is the only reason a system like this gets used instead of ignored. @@ -29,7 +29,7 @@ seconds, standing up, one-handed, holding a cup.** Everything else followed from | | | |---|---| -| **Frontend** | React, Vite, TypeScript, Tailwind — a PWA, installable on the tablet | +| **Frontend** | React, Vite, TypeScript, Tailwind – a PWA, installable on the tablet | | **Database** | PostgreSQL on Supabase, with row-level security | | **API and jobs** | serverless functions, plus a scheduled month-end run | | **Mail** | the monthly report, as the email body rather than an attachment | @@ -57,7 +57,7 @@ project normally stops. ## Running it somewhere else Several campuses have the same sheet of paper. If yours is one of them, open an issue or get in -touch — the second deployment is deliberately much cheaper than the first. +touch – the second deployment is deliberately much cheaper than the first. Security reports go to [`SECURITY.md`](https://github.com/kaffeelisten/.github/blob/main/SECURITY.md), not to the issue tracker.