Skip to content

fix(docs-gate): accept root CONTRIBUTING.adoc — 94% of failures were false positives - #850

Merged
hyperpolymath merged 1 commit into
mainfrom
fix/docs-gate-accept-root-contributing-adoc
Sep 18, 2026
Merged

hyperpolymath merged 1 commit into
mainfrom
fix/docs-gate-accept-root-contributing-adoc

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

Replaces have CONTRIBUTING.md 3-practice/CONTRIBUTING.adoc with a version that also accepts a root CONTRIBUTING.adoc.

Why

This script's own header states the estate policy is “AsciiDoc is the default”, and it accepts README.adoc and LICENSE.txt — but for CONTRIBUTING it never accepted a root .adoc.

ENFORCE_CONTRIBUTING_FROM=2026-08-21 armed itself on that date (“on the cutoff date this check starts failing with no further edit to this file”), so this gate is now blocking.

Measured blast radius, 2026-09-18, random sample of 40 repos:

passes the gate                  6
FALSE POSITIVE (.adoc only)     32
genuinely missing the document   2

32/34 = 94% of the repos this gate reports as non-compliant do have the document, at the path the estate actually uses. All seven of the currently conflicted-PR repos (bqniser, mylangiser, nextgen-databases, nimiser, phronesiser, pimcore-fortress, tlaiser) fail on this and on nothing else.

Controlled reproduction:

root CONTRIBUTING.adoc only     -> exit=1
+ 3-practice/CONTRIBUTING.adoc  -> exit=0
+ root CONTRIBUTING.md          -> exit=0

Why the #505 suite did not catch it

The existing “alternate extensions accepted” fixture places CONTRIBUTING.adoc only under 3-practice/, never at the root.

Verification

Check Result
Suite before change 22 passed, 0 failed
Suite with fix 24 passed, 0 failed
Suite with only the gate line reverted 23 passed, 1 failed (the new fixture)
7 real repos at DOCS_TODAY=2026-09-18 all exit=0 (were exit=1)

The revert row is the point: a regression fixture that still passes against broken code proves nothing.

…false positives

`have CONTRIBUTING.md 3-practice/CONTRIBUTING.adoc` never accepted a root
CONTRIBUTING.adoc, even though this script's own header states the estate
policy is "AsciiDoc is the default" and README/LICENSE both accept .adoc.

The CONTRIBUTING cutoff armed itself on 2026-08-21 (ENFORCE_CONTRIBUTING_FROM),
so as of today this gate blocks. Measured blast radius, 2026-09-18, random
sample of 40 repos:

    passes the gate                  6
    FALSE POSITIVE (.adoc only)     32
    genuinely missing the document   2

i.e. 32/34 = 94% of the repos this gate reports non-compliant do have the
document, at the path the estate actually uses. Every 7 of the currently
conflicted PR repos (bqniser, mylangiser, nextgen-databases, nimiser,
phronesiser, pimcore-fortress, tlaiser) fail on this and on nothing else.

The #505 fixture suite did not catch it: "alternate extensions accepted"
places CONTRIBUTING.adoc only under 3-practice/, never at the root.

Adds two fixtures — root CONTRIBUTING.adoc passes post-cutoff, and still
warns-then-blocks when genuinely absent. Reverting just the gate line makes
the first fixture fail (24/24 -> 23/1), so it is a real regression test.
@coderabbitai

coderabbitai Bot commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: d784c285-d8ad-47a0-9aa0-1f6d3a198503

📥 Commits

Reviewing files that changed from the base of the PR and between c5f469c and ada7794.

📒 Files selected for processing (2)
  • scripts/check-docs-presence.sh
  • scripts/tests/governance-gates-505-test.sh
 ____________________________________________________________________
< Never go full rewrite. You don't buy that? Ask Netscape Navigator. >
 --------------------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sonarqubecloud

Copy link
Copy Markdown

@hyperpolymath
hyperpolymath merged commit 950bbbc into main Sep 18, 2026
23 of 30 checks passed
@hyperpolymath
hyperpolymath deleted the fix/docs-gate-accept-root-contributing-adoc branch September 18, 2026 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant