Skip to content
Merged
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
44 changes: 38 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ in mind for every page.

## Data contribution model

Most pages are generated from data files. Contribute by editing the data, not
by hand-building pages:
Most pages are generated from data files. Contribute by editing the data, not by
hand-building pages:

| Page | Data source | Validation |
|---|---|---|
| `/awards` | `data/awards.json` | `npm run validate:awards` |
| `/metrics` | `data/metrics.json` (generated) | `npm run validate:metrics` |
| Page | Data source | Validation |
| ---------------- | ----------------------------------- | -------------------------------- |
| `/awards` | `data/awards.json` | `npm run validate:awards` |
| `/metrics` | `data/metrics.json` (generated) | `npm run validate:metrics` |
| `/architectures` | `data/architectures/records/*.json` | `npm run validate:architectures` |

Rules:
Expand All @@ -55,6 +55,38 @@ Rules:
sections (practitioners, events, metrics, awards) intentionally have no
sidebar; multi-page sections (architectures, community) do.

## Good first issues

New to this repository? Start with an issue labeled
[`good first issue`](https://github.com/cncf/endusers/labels/good%20first%20issue).
These are scoped for a first contribution: each names the file(s) to touch and
the acceptance criteria for the change.

- **#77 — Awards data verification**: Audit `data/awards.json` against the CNCF
End User Award history published on
[cncf.io/announcements](https://www.cncf.io/announcements/), add a `source`
URL per entry linking its announcement, and flag any missing years.
Acceptance: every entry has a source link and the count matches the published
history.
- **#75 — Events page upcoming-event tracking**: Restructure
`docs/events/index.md` into "Upcoming" and "Past" sections and add the next
scheduled KubeCon + CloudNativeCon end-user events (End User Summit, End User
Reception) with authoritative
[events.linuxfoundation.org](https://events.linuxfoundation.org/) links.
Acceptance: at least one upcoming event is listed, and no past event appears
under "Upcoming".
- **#80 — Architectures freshness indicator**: Surface the import revision/date
already recorded in `data/metrics.json`'s `sources.architectures` on the
architectures index page as a "last synced from cncf/architecture @ `<rev>`"
line. Acceptance: the architectures page shows the upstream revision and sync
date.
- **Docs/typo sweep**: Read through `docs/` and the top-level `*.md` files for
broken links, stale version numbers, or typos and open small, focused fixes.
No issue required — a PR is enough for this one.

If none of these have the `good first issue` label yet, they are still fair
game: mention in your pull request which one you picked up.

## Making changes

1. Fork the repository and create a branch from `main`.
Expand Down