You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 058219a
Browse filesBrowse the repository at this point in the historyBrowse files
release: no persisted token during the check suite (#251); contributor docs cover deprecations and spdx-allowed (#269)
- release.yml checks out with persist-credentials: false and hands the
token only to the CITATION push step
- CONTRIBUTING step 5, the status rule and the PR template say deprecating
an entry needs npm run counts; the V6 messages say so too
- a new licence also needs its SPDX id in site/spdx-allowed.json
- releases run on Node 24; PRs and pushes on 24 and 22
Closes#251Closes#269
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LpkeXQPaUhxjgqdqnk6BrJ
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@
11
11
-[ ]`id` is unique across the whole catalog
12
12
-[ ] Live license checked today; `## Evidence` has a dated line quoting it
13
13
-[ ] Row added to the category `README.md`, with the same licence as the frontmatter
14
-
-[ ] Ran `node site/sync-counts.mjs` after addingor removing entries
14
+
-[ ] Ran `node site/sync-counts.mjs` after adding, removing or deprecating entries
15
15
-[ ] Stacks: followed `stacks/README.md`; no licence named in a stack's own words
16
16
-[ ]`npm test && npm run validate` passes locally (CI runs the full `npm run check`: see [What CI runs](https://github.com/TMHSDigital/Free-Game-Dev-Assets/blob/main/CONTRIBUTING.md#what-ci-runs))
17
17
-[ ] If I publish the source, I say so above; if an agent or script drafted this, every licence fact was still read at the source by me
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ The website rebuilds from frontmatter on deploy. Node 22 or newer is all you nee
36
36
2. Verify the license on the live source page the day you submit, and fill every frontmatter field from it (rules below). Prefer primary URLs over mirror/aggregator pages.
37
37
3. Write the body: a one-paragraph summary, `## Notes`, `## Evidence` with a dated line quoting the source, such as `- Live page (2026-09-25): "Free for commercial use"`, and optionally `## Related` linking sibling entries. Every Evidence section needs at least one date, and `verified` may not be newer than the newest one. The template (and so the scaffold) starts at `status: needs-review`; set `active` once the licence, the commercial stance and the credit requirement are all settled.
38
38
4. Add a row to the matching category `README.md`. This is required: the validator fails an entry that is not listed there, and the row's licence cell must match your frontmatter.
39
-
5. Run `node site/sync-counts.mjs` (`npm run counts`). It updates every place the repo restates the entry count: both category count tables, the README badge and "Browse N sources" line, and `expectedEntryCount` in [`site/config.json`](site/config.json).
39
+
5. Run `node site/sync-counts.mjs` (`npm run counts`) whenever you add, remove or deprecate an entry: the counts include listed entries only, so `status: deprecated` changes them too. It updates every place the repo restates the entry count: both category count tables, the README badge and "Browse N sources" line, and `expectedEntryCount` in [`site/config.json`](site/config.json).
40
40
6. Run `npm test && npm run validate` before you push; that is quick. CI then runs `npm run check` (the steps are listed under [What CI runs](#what-ci-runs)), and all of it must pass. Run `npm run check` yourself if you changed the site or want to preview your entry's page. The build renders your entry's page and fails if the body uses markdown the site does not support (tables, code fences, blockquotes, images, raw HTML, `###` headings, numbered lists) or links to a file that does not exist.
41
41
7. Save files with LF line endings. `.editorconfig` and `.gitattributes` take care of it in most editors; the validator rejects a file that still contains a CR.
42
42
8. Optional: add the `id` to `site/config.json` → `featured` to pin it under Safe starting points.
@@ -45,7 +45,7 @@ To add a starter stack (one pick per need for a kind of game), follow [`stacks/R
45
45
46
46
### Frontmatter rules
47
47
48
-
-`license`: the source's licence, written as one of the values in [`site/license-vocabulary.json`](site/license-vocabulary.json) (e.g. `CC0`, `CC-BY-3.0`, `SIL OFL`, `GPL-3.0-or-later`, `custom`, `varies`). If the source uses a licence the vocabulary lacks, add it there first, with its SPDX mapping and attribution class. For GPL, record `-only` or `-or-later` only when the project itself says which; otherwise use the bare `GPL-2.0` or `GPL-3.0`.
48
+
-`license`: the source's licence, written as one of the values in [`site/license-vocabulary.json`](site/license-vocabulary.json) (e.g. `CC0`, `CC-BY-3.0`, `SIL OFL`, `GPL-3.0-or-later`, `custom`, `varies`). If the source uses a licence the vocabulary lacks, add it there first, with its SPDX mapping and attribution class, and add the SPDX id to [`site/spdx-allowed.json`](site/spdx-allowed.json); the validator rejects any `license_spdx` missing from that list. For GPL, record `-only` or `-or-later` only when the project itself says which; otherwise use the bare `GPL-2.0` or `GPL-3.0`.
49
49
-`license_spdx`: the SPDX identifier the vocabulary maps your `license` to. The validator rejects a missing one when a mapping exists, and an invented one when it does not.
50
50
-`commercial`: `true` / `false` / `unknown` / `varies`. Use `varies` for aggregators where some files are commercial-ok and others are not. The site still shows these under Commercial OK, labeled **per-file review**, so they are not silently excluded and not silently treated as a blanket grant.
51
51
-`attribution_required`: `true` / `false` / `unknown`. If the licence normally requires credit (CC-BY) but the publisher waives it, set `false` and add a `- Attribution waived:` line in Notes saying so. The validator requires that waiver to be quoted on a dated Evidence line (V38).
@@ -65,12 +65,12 @@ To add a starter stack (one pick per need for a kind of game), follow [`stacks/R
65
65
-`url`: an `https://` address (`http://` only where the source has no https). Other schemes are rejected.
66
66
-`added`: ISO date (`YYYY-MM-DD`) the entry joined the catalog. `npm run new-entry` fills it in; it never changes afterwards (V26: a real date, not in the future). The "new sources" feed and the home page's "New in the last 30 days" line key on it, so a re-verification sweep does not look like a wave of new entries. Moving an entry to another category keeps its date: `npm run check-added` (run in CI) fails when `added` is later than the file's first commit, following renames.
67
67
-`verified`: ISO date (`YYYY-MM-DD`) of your last license check. It must be a real date, no later than tomorrow in UTC, and no newer than the newest date in `## Evidence` (V8): a new `verified` date needs a new dated Evidence line from the same check. Dates inside URLs do not count as Evidence dates.
68
-
-`status`: `active` | `needs-review` | `deprecated`. A `deprecated` entry needs a `- Deprecated:` line in its body giving the reason (V9). `active` means the licence, the commercial stance and the credit requirement are all settled: an `unknown` in `license`, `commercial` or `attribution_required` keeps an entry at `needs-review`. The validator enforces this (V14), and rejects `formats`, `subcategories` or `tags` values that differ only by case, punctuation or a trailing "s" from one already in use (V13).
68
+
-`status`: `active` | `needs-review` | `deprecated`. A `deprecated` entry needs a `- Deprecated:` line in its body giving the reason (V9), and `npm run counts` afterwards, since deprecated entries leave the counts (V6). `active` means the licence, the commercial stance and the credit requirement are all settled: an `unknown` in `license`, `commercial` or `attribution_required` keeps an entry at `needs-review`. The validator enforces this (V14), and rejects `formats`, `subcategories` or `tags` values that differ only by case, punctuation or a trailing "s" from one already in use (V13).
69
69
- No other keys. An unknown key is rejected with the nearest allowed one (V33): `id`, `name`, `url`, `publisher`, `category`, `subcategories`, `license`, `license_spdx`, `commercial`, `attribution_required`, `attribution_string`, `formats`, `tags`, `added`, `verified`, `status`, `engine_lock`, `ue_versions`, `camera_perspective`, `grid_dimensions`, `maintenance`, `hardware_tags`, `preview` and `limits`. A typo such as `engine-lock` would otherwise drop the fact silently. Block-list items are indented under their key (` - item`), and every key needs a space after its colon.
70
70
71
71
## What CI runs
72
72
73
-
Every pull request, every push to `main` (before the site deploys) and every release run one sequence, `npm run check` in [`package.json`](package.json), on Node 24 and again on Node 22:
73
+
Every pull request, every push to `main` (before the site deploys) and every release run one sequence, `npm run check` in [`package.json`](package.json). Pull requests and pushes run it on Node 24 and again on Node 22; releases run it on Node 24:
74
74
75
75
1.`npm run lint` (`site/lint.mjs`): every script parses, and none imports a name it does not use.
76
76
2.`npm test`: the checks against known-bad fixtures (`site/checks.test.mjs`) and the site modules' tests (`site/lib/lib.test.mjs`).
0 commit comments