Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/1-bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Inside a stack, title each layer `[n/N] type(scope): summary` and list the stack
<!-- What you actually ran or clicked. "CI is green" is not verification on its own. -->

- [ ] `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

Expand All @@ -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

<!-- The part you are least sure about. Say so — it is the most useful line in a pull request. -->
<!-- The part you are least sure about. Say so – it is the most useful line in a pull request. -->
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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&times;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. |
Expand All @@ -29,5 +29,5 @@ Images are referenced by absolute `raw.githubusercontent.com` URL inside a `<pic
because GitHub strips inline SVG out of Markdown and relative paths do not resolve on the profile
page.

Changing a template here changes it for every repository at once. Check the forms still render —
Changing a template here changes it for every repository at once. Check the forms still render –
a malformed `.yml` fails silently and the form simply stops appearing.
21 changes: 17 additions & 4 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,27 @@ Applies to every repository in the `kaffeelisten` organisation.
## Reporting a vulnerability

**Do not open a public issue.** Use GitHub's private vulnerability reporting on the affected
repository — the **Security** tab, then **Report a vulnerability**. It opens a private thread
repository – the **Security** tab, then **Report a vulnerability**. It opens a private thread
visible only to the maintainers.

If that is unavailable to you, open a public issue containing **only** the words "security report,
please make contact" and nothing else, and we will reach out privately.

We will acknowledge a report within **seven days** and tell you what we intend to do about it.
This is a two-person project rather than a company, so we will not promise a fix window we cannot
keep — but we will be honest about what we are doing and when.
keep – but we will be honest about what we are doing and when.

## What we would especially like to hear about

Kaffeelisten holds personal data: the names of campus members, the company each belongs to, and a
record of what each person consumed. The things that worry us most:

- **Row-level security gaps** — any path by which an anonymous client reads or writes rows it
- **Row-level security gaps** – any path by which an anonymous client reads or writes rows it
should not.
- **Reaching an administrative endpoint without the PIN**, or bypassing the server-side check.
- **Leaking the service-role key** or any server-side secret into the client bundle.
- **Anything that lets one company see another company's consumption.**
- **Report or archive tampering** — months are meant to be immutable once archived.
- **Report or archive tampering** – months are meant to be immutable once archived.

## Out of scope

Expand All @@ -42,6 +42,19 @@ record of what each person consumed. The things that worry us most:
Please give us **90 days** before publishing, or less by agreement if a fix lands sooner. We are
glad to credit you by name, or not, whichever you prefer.

## With thanks

People outside the project who reported something real, and what came of it. Credited by name
because the policy above offers it; anyone who would rather not be listed only has to say so.

| | |
|---|---|
| **Gianna Gonzales**, Perch Scan · 6 November 2026 | Found that the payment grid's query silently truncated once the window held more than 1,000 unarchived transactions, so it understated amounts owed. Correct, and the same pattern turned out to be in six other places, the month-end report among them – [kaffeelisten#62](https://github.com/kaffeelisten/kaffeelisten/issues/62). Fixed 10 November 2026 |

An automated scan found it, which the scope section above sets aside – but the report said what
the finding meant for this application rather than quoting a rule number, which is the part that
made it worth reading. That distinction is the one that matters to us.

## Please do not

Test against the live campus deployment. It holds real people's data and real consumption records.
Expand Down
14 changes: 7 additions & 7 deletions brand/BRAND.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Kaffeelisten — brand
# Kaffeelisten – brand

The essentials, and where the full book lives.

Expand All @@ -10,7 +10,7 @@ authored by hand.

## The wordmark

**Kaffee**listen — one unbroken word, `Kaffee` in ink and `listen` in amber, the colour changing
**Kaffee**listen – one unbroken word, `Kaffee` in ink and `listen` in amber, the colour changing
mid-word with no gap. Beneath it: *Die Kaffeeliste – ohne Papier.*

It stacks on two lines for tall or narrow surfaces. Never break the word, recolour either half,
Expand All @@ -20,15 +20,15 @@ set it light, or letterspace it loosely.

| | |
|---|---|
| `logo/logo.svg` | The logo — amber rounded square, white line cappuccino. |
| `logo/logo.svg` | The logo – amber rounded square, white line cappuccino. |
| `logo/logo-itc1.svg`, `-wald.svg`, `-imperium.svg` | Palette variants. |
| `logo/logo-mono.svg` | Single colour, for one-colour printing. |
| `logo/mark-cappuccino.svg`, `mark-deathstar.svg` | The marks alone, `currentColor`. |
| `logo/avatar-1024.png`, `-512.png` | The organisation avatar: the mark on brand paper. Upload the 1024; the 512 is for anywhere that wants a smaller file. |

The avatar is **not** the logo scaled down. It is its own artwork: a torn-paper cup, kept as `plates/avatar-cup.png` in the playbook and framed square with the deckled edge whole. It is **transparent**, so it sits on either GitHub theme, and it carries no wordmark and no tagline. Reframe it from the plate; do not scale the logo into the slot.

`rx="40"` on a 200×200 viewBox — a 20% corner radius, kept at every size. The mark stays white on
`rx="40"` on a 200×200 viewBox – a 20% corner radius, kept at every size. The mark stays white on
the square in every palette.

## Colour
Expand All @@ -46,7 +46,7 @@ amber.

## Type

**Inter** — 800 for the wordmark with tight tracking, 400 for the tagline. **JetBrains Mono** for
**Inter** – 800 for the wordmark with tight tracking, 400 for the tagline. **JetBrains Mono** for
figures and identifiers.

## The assets here
Expand All @@ -64,7 +64,7 @@ figures and identifiers.
| `assets/x-header.jpg` | 1500×500. X / Twitter header; the bottom-left is kept calm for the profile picture. |
| `assets/story.jpg` | 1080×1920. Story; top and bottom kept clear for the platform's UI. |

Every file is rebuilt from pixels only — no EXIF, no XMP, no C2PA chunk.
Every file is rebuilt from pixels only – no EXIF, no XMP, no C2PA chunk.

## Using them

Expand All @@ -77,6 +77,6 @@ Every file is rebuilt from pixels only — no EXIF, no XMP, no C2PA chunk.

## Not the design system

Component specs, spacing, the type scale and the semantic tokens live in the product repository —
Component specs, spacing, the type scale and the semantic tokens live in the product repository –
`docs/design-system.md` and `docs/design-foundation.md`. The colours above are copied *from* the
app's `index.css`. Where the two disagree, the product repository wins.
8 changes: 4 additions & 4 deletions profile/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<img src="https://raw.githubusercontent.com/kaffeelisten/.github/main/brand/assets/readme-banner.jpg" alt="Kaffeelisten — die Kaffeeliste, ohne Papier" width="860">
<img src="https://raw.githubusercontent.com/kaffeelisten/.github/main/brand/assets/readme-banner.jpg" alt="Kaffeelisten – die Kaffeeliste, ohne Papier" width="860">

# 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.

Expand All @@ -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 |
Expand Down Expand Up @@ -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.
Loading