Skip to content

chore(RAN-54): add CONTRIBUTING.md + retarget 4 _url fields to conventional paths#7

Merged
aksOps merged 1 commit intomainfrom
chore/ran-54-conventional-urls
Apr 26, 2026
Merged

chore(RAN-54): add CONTRIBUTING.md + retarget 4 _url fields to conventional paths#7
aksOps merged 1 commit intomainfrom
chore/ran-54-conventional-urls

Conversation

@aksOps
Copy link
Copy Markdown
Contributor

@aksOps aksOps commented Apr 26, 2026

Summary

Bestpractices.dev autofill audit follow-up (board comment 0988aa47 on RAN-54). The board re-listed four MUST/SHOULD criteria still flagged on the project page despite _status: Met in our JSON.

Root cause: the bestpractices.dev autofill bot detects evidence by conventional path, not by the _url field. Our URLs pointed at non-conventional locations. Sibling otelcontext (the closest single-product MIT analog) uses the conventional pattern and the autofill flips them all to Met automatically.

Changes

Added

  • CONTRIBUTING.md at repo root — conventional path the autofill bot detects. §Reporting (Issues + SECURITY.md), §Development workflow (Conventional Commits, signed commits, auto-merge), §What every PR must pass (8-row CI gate matrix with local commands), §Coding standards (delegates the full bar to shared/runbooks/engineering-standards.md).

Retargeted in .bestpractices.json (status was already Met for all four — only URLs and justifications changed)

Criterion Old _url New _url
contribution engineering-standards.md CONTRIBUTING.md
contribution_requirements engineering-standards.md CONTRIBUTING.md
documentation_basics docs/README.md (index) README.md (the actual docs)
report_process /issues SECURITY.md (otelcontext recipe match)
release_notes CHANGELOG.md unchanged (no tagged releases yet, no /releases to point at; CHANGELOG.md is the right answer per criterion text)

Justifications refreshed to cite the new URL targets without changing the factual claim.

Verified locally

  • JSON parses (152 top-level keys, 67 _status keys, 0 remaining ?)
  • No script changes — Test-SnipIT.ps1 84/84 unaffected, PSScriptAnalyzer 0 errors unaffected.

Post-merge

  • Bestpractices.dev autofill rescan should flip the four flagged criteria to Met.
  • Per the Bestpractices board-approval gate, RAN-54 stays in_review until the board flips the badge to passing and posts @TechLead approved.

Test plan

  • JSON validates
  • CI on PR (test.yml + security.yml + scorecard.yml) green
  • Bestpractices.dev autofill rescan picks up CONTRIBUTING.md + new URL targets
  • All four flagged criteria show Met on the project page after rescan

🤖 Generated with Claude Code

…tional paths

Bestpractices.dev autofill audit follow-up (board comment 0988aa47 on RAN-54).
The board re-listed four MUST/SHOULD criteria still flagged on the project
page despite `_status: Met` in our JSON. Root cause: the autofill bot
detects evidence by *conventional path*, not by the _url field — and our
URLs pointed at non-conventional locations (docs/README.md as an index,
shared/runbooks/engineering-standards.md as the contribution doc, /issues
for report_process). Sibling otelcontext (the closest single-product MIT
analog) uses the conventional pattern and the autofill flips them all to
Met automatically.

Added:
  - CONTRIBUTING.md  Conventional path the autofill bot detects.
                     §Reporting (Issues + SECURITY.md), §Development workflow
                     (Conventional Commits, signed commits, auto-merge),
                     §What every PR must pass (8-row CI gate matrix with
                     local commands), §Coding standards (delegates the full
                     bar to shared/runbooks/engineering-standards.md).

Retargeted in .bestpractices.json (status was already Met for all four):
  - contribution_url            engineering-standards.md -> CONTRIBUTING.md
  - contribution_requirements_url  engineering-standards.md -> CONTRIBUTING.md
  - documentation_basics_url    docs/README.md (index) -> README.md (the docs)
  - report_process_url          /issues -> SECURITY.md (matches the
                                otelcontext recipe; SECURITY.md links to
                                /issues for non-security bugs and is the
                                conventional location autofill detects)
  - release_notes_url           unchanged (CHANGELOG.md is the right answer
                                — no tagged releases yet, no /releases
                                endpoint to point at)

Justifications refreshed to cite the new URL targets without changing the
factual claim.

After this lands the autofill rescan should flip the four flagged criteria
to Met on bestpractices.dev. Per the Bestpractices board-approval gate
RAN-54 stays in_review — board flips the badge to passing and posts
@techlead approved.

Verified locally: JSON parses (152 top-level keys, 67 _status keys, 0
remaining `?`), no script changes (Test-SnipIT.ps1 84/84 unaffected,
PSScriptAnalyzer 0 errors unaffected).

Co-Authored-By: Paperclip <noreply@paperclip.ing>
@aksOps aksOps enabled auto-merge (squash) April 26, 2026 04:51
@aksOps aksOps merged commit 7a30cf0 into main Apr 26, 2026
12 checks passed
@aksOps aksOps deleted the chore/ran-54-conventional-urls branch April 26, 2026 04:52
aksOps added a commit that referenced this pull request Apr 26, 2026
…ersioning evidence (#8)

CHANGELOG.md
- [Unreleased] → [v0.1.0] - 2026-04-26 with full Added / Changed / Fixed / Security
  subsections covering PR #1 (RAN-54 baseline + Scorecard hardening), PR #3 (RAN-59
  canonical-schema rewrite), PRs #4/#5 (RAN-64 CHANGELOG + docs/ index), PR #6
  (5 SUGGESTED criteria flips), PR #7 (CONTRIBUTING.md + conventional-URL retargets).
- Fresh empty [Unreleased] section opened at top per Keep-a-Changelog 1.1.0.
- Link refs now point at compare/v0.1.0...HEAD and releases/tag/v0.1.0.

.bestpractices.json
- version_unique_url + release_notes_vulns_url added (both pointing at the v0.1.0
  GitHub Release) so the bestpractices.dev autofill bot has a concrete URL to
  verify alongside _status: Met.
- 5 versioning justifications refreshed to cite the concrete v0.1.0 tag instead of
  forward-looking commitments: version_unique, version_semver, version_tags,
  release_notes, release_notes_vulns. These are the criteria the autofill bot
  verifies by checking actual GitHub Releases / git tags exist.

Once the v0.1.0 signed tag + GitHub Release land post-merge, autofill should flip
release_notes to Met (currently Unmet pending evidence) and the 4 SUGGESTED
versioning criteria stay Met with concrete tag-backed URLs.

Co-authored-by: Paperclip <noreply@paperclip.ing>
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