Skip to content

Commit 5e064fc

Browse files
TMHSDigitalclaude
andauthored
docs: rules for publishers listing their own source and for agent-drafted PRs (#123)
Two gaps surfaced by PRs #78 (publisher-submitted entry) and #122 (automated PR with an unwired test file). CONTRIBUTING gains a section on each; the PR template gains one checkbox covering both. Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
1 parent 748e11c commit 5e064fc

2 files changed

Lines changed: 9 additions & 0 deletions

File tree

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@
1414
- [ ] Ran `node site/sync-counts.mjs` after adding or removing entries
1515
- [ ] Stacks: followed `stacks/README.md`; no licence named in a stack's own words
1616
- [ ] `npm test && npm run validate` passes locally (CI runs the full `npm run check`, including the build)
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

‎CONTRIBUTING.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,14 @@ To add a starter stack (one pick per need for a kind of game), follow [`stacks/R
7373
- [ ] Entry does not claim rights we don’t have
7474
- [ ] Tool entries distinguish **software license** from **exported asset** ownership
7575

76+
## Submitting your own source
77+
78+
Publishers are welcome to list their own work. Say so in the pull request, write the entry as a third party would (facts the source states, no comparisons with other entries, no ranking language), and start it at `needs-review` so a maintainer re-reads the licence before it goes `active`. A free tier of a paid product is listed as the free tier only, with the paid tier named in Notes and not linked as the entry's `url`. A one-time notice or upsell inside a tool is recorded in Notes as a fact.
79+
80+
## Automated and AI-assisted pull requests
81+
82+
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.
83+
7684
## Research notes
7785

7886
Local Gemini / deep-research drafts live under `RESEARCH/` as `R0N-<topic>.md` (mostly gitignored; see [`docs/research-index.md`](docs/research-index.md)). Promote durable findings into catalog entries and `docs/` — don’t rely on drafts as the public source of truth.

0 commit comments

Comments
 (0)