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 134d29e
Browse filesBrowse the repository at this point in the historyBrowse files
- "Reading an entry" (statuses and the field table) -> docs/entry-format.md
- the 19-row starter table, a copy of site/config.json featured that could
drift, becomes a link to the site's starter table
- Licences: one paragraph linking every guide; its short version table
moves to the top of docs/licenses.md
- Godot and Unreal shortened to two lines each
- local commands and the repository layout move to CONTRIBUTING.md
(#repository-layout)
- the gallery keeps one row
Every heading the Contents line and other files link to is kept;
validate reports no broken links.
Closes#121
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: CONTRIBUTING.md
+62Lines changed: 62 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -121,6 +121,68 @@ A publisher who would rather not have their preview shown can open an issue; the
121
121
122
122
Changes drafted with an agent or a script are judged on the diff like any other. Keep them small, keep tests in `site/checks.test.mjs` or `site/lib/lib.test.mjs` (a test file that `npm test` does not run is dropped), and name the issue the change fixes in the body (`Fixes #N`). A pull request that lists sources or licences the author did not read is closed: the catalog's one rule is that every licence fact was read at the source by the person who recorded it.
123
123
124
+
## Repository layout
125
+
126
+
Node 22 or newer (CI and `.nvmrc` use 24); there is nothing to install.
127
+
128
+
```bash
129
+
npm run check # what CI runs: lint, tests, validate, check-added, build (CONTRIBUTING.md#what-ci-runs)
130
+
npm test# the checks against known-bad fixtures, and the site modules' tests
131
+
npm run validate # the catalog, against the checks (node site/validate.mjs)
132
+
npm run build # builds the site into site/dist (node site/build.mjs)
133
+
npm run serve # preview at http://127.0.0.1:3000 (node site/serve.mjs, no download)
134
+
```
135
+
136
+
```text
137
+
.
138
+
├── README.md
139
+
├── CONTRIBUTING.md how to add and verify an entry
│ ├── entry-format.md what an entry's statuses and fields mean
157
+
│ ├── for-publishers.md what is recorded about a publisher, and how to correct it
158
+
│ ├── internal/ design specs and plans behind the site (history, not guides)
159
+
│ ├── review-ledger.md every review pass and what it changed
160
+
│ └── images/readme/ publisher stills used in this README, and the social card (og-card.png)
161
+
├── stacks/ starter stacks: one pick per need for a kind of game
162
+
├── site/
163
+
│ ├── validate.mjs catalog integrity checks
164
+
│ ├── checks.mjs the checks, as pure functions
165
+
│ ├── checks.test.mjs fixtures proving each check fails on bad input
166
+
│ ├── lint.mjs every script parses; no unused imports
167
+
│ ├── check-added.mjs `added` dates against git history
168
+
│ ├── pr-diff.mjs a pull request's licence-field changes, for the run summary
169
+
│ ├── new-entry.mjs starts an entry from the template
170
+
│ ├── sync-counts.mjs rewrites every restated entry count
171
+
│ ├── serve.mjs local preview server for site/dist
172
+
│ ├── license-vocabulary.json the licence values the catalog accepts
173
+
│ ├── format-vocabulary.json the format values the catalog accepts, and filter groups
174
+
│ ├── value-aliases.json retired spellings of tags, formats and subcategories
175
+
│ ├── spdx-allowed.json SPDX identifiers in use
176
+
│ ├── check-links.mjs weekly source link check
177
+
│ ├── reverify-batch.mjs picks the monthly re-verification batch
178
+
│ ├── thumbs.mjs thumbs.json fetches preview thumbnails, and their manifest
179
+
│ ├── build.mjs config.json static site generator and its settings
180
+
│ ├── data.schema.json JSON Schema for data.json (attached to each release)
181
+
│ ├── lib/ page renderers and shared helpers, with lib.test.mjs
182
+
│ └── public/ page, styles and script
183
+
└── package.json npm scripts only; no dependencies
184
+
```
185
+
124
186
## Licence of contributions
125
187
126
188
By opening a pull request you dedicate your contribution to the public domain under [CC0 1.0](LICENSE), like the rest of the repository's metadata and documentation. Quotes from licence pages stay the publisher's words; they are used as short factual quotations, and the assets they describe keep their own licences.
0 commit comments