Skip to content

docs: fix wording faults in the repo standards and settle five rules - #25

Merged
thatsrue merged 1 commit into
mainfrom
docs/standard-wording
Nov 21, 2026
Merged

thatsrue merged 1 commit into
mainfrom
docs/standard-wording

Conversation

@thatsrue

Copy link
Copy Markdown
Collaborator

What changed

Wording faults, no rule change:

  • The job-level if: rule now excepts the automerge and deploy-merged jobs, which the Dependabot section prescribes with a job-level if:.
  • The one-gate-script rule and the word-site exception were each written twice. Each now lives in one place.
  • The contract-test exception names its condition instead of two private repositories.

Rules settled by the owner:

  • A private repo may write the runner as ${{ vars.RUNNER || 'ubuntu-latest' }} for the self-hosted runner.
  • The language-tool table covers code the repo ships and its tests.
  • .oxlintrc.json denies warnings with options.denyWarnings: true, named exactly so it can be checked.
  • Node repos ignore @types/node major updates; it moves with .nvmrc, by hand.
  • A GitHub release is needed when it is the release-notes home, and immutable releases apply to repos that publish GitHub releases. This removes a contradiction with the rule that lets docs/changelog.md be that home.

Why

An audit of 28 repositories against the standard found one rule the standard's own prescribed jobs break, two rules stated twice, private repository names in this public file, and places where the text and the repositories disagreed with no shown harm. Two independent reviews argued against each proposed rule change; these five are what survived. Left as written, with the differing repositories recorded instead: site names, the commit-type table, seconds per step, and uv.lock for Python.

No issue: docs

How you checked it

  • scripts/check: 0

  • Every relative link in docs/repo-standards.md resolves, including the new #dependabot anchor.

  • options.denyWarnings exists since oxlint 1.52.0; with it a lint warning exits 1, as with --deny-warnings (tested on 1.88).

  • Dependabot runs in the private repositories do land on the self-hosted runner.

  • A bug fix comes with a test that fails without it

  • Docs match how it works now

  • No secrets or private information

@thatsrue thatsrue added the documentation Improvements or additions to documentation label Nov 21, 2026
@thatsrue
thatsrue merged commit 27b4103 into main Nov 21, 2026
1 check passed
@thatsrue
thatsrue deleted the docs/standard-wording branch November 21, 2026 00:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Development

Successfully merging this pull request may close these issues.

1 participant