Skip to content

Propose release-hardening and code-health RFCs - #556

Draft
leynos wants to merge 2 commits into
mainfrom
release-hardening-code-health-rfcs
Draft

Propose release-hardening and code-health RFCs#556
leynos wants to merge 2 commits into
mainfrom
release-hardening-code-health-rfcs

Conversation

@leynos

@leynos leynos commented Aug 11, 2026

Copy link
Copy Markdown
Owner

Summary

This branch proposes complementary release-hardening and code-health RFCs so
that Netsuke can review stronger release admission, repository-wide policy
validation, and fuzzing contracts before implementation begins. The proposals
draw explicit inspiration from the upstream
VTCode repository while retaining Netsuke's
existing Polonius, Whitaker, property-testing, model-checking, mutation-testing,
and release-integrity practices.

It also establishes the numbered RFC directory in the documentation index and
repository layout.

Review walkthrough

  • Start with
    RFC 0001
    for the proposed release-profile invariants, secret and dependency policy,
    and exact-commit admission evidence.
  • Then review
    RFC 0002
    for workflow-policy validation, gate self-consistency, exception hygiene,
    and scheduled coverage-guided fuzzing.
  • Finish with the
    documentation contents
    and
    repository layout
    entries that make the RFC series discoverable.

Validation

  • make fmt: passed
  • make markdownlint: passed; 80 Markdown files checked with zero errors
  • make nixie: passed; all Mermaid diagrams validated
  • git diff --check origin/main...HEAD: passed

Notes

This is a documentation-only, pre-implementation proposal. Adoption decisions,
tool versions, budgets, and staged implementation details remain subject to RFC
review.

Summary by Sourcery

Introduce numbered RFCs for release hardening and repository-wide code health, and integrate them into the documentation index and layout.

Enhancements:

  • Clarify contributor guidance by defining where cross-cutting proposals live and how RFCs should be numbered, linked, and maintained in the repo.

Documentation:

  • Add RFC 0001 documenting proposed release integrity, secret scanning, dependency/licence policy, and exact-commit release admission requirements.
  • Add RFC 0002 documenting proposed workflow-policy validation, gate self-consistency, exception hygiene, and scheduled fuzzing and health-tier contracts.
  • Update documentation contents and repository layout to establish the docs/rfcs/ directory and make RFCs discoverable from the docs index.

leynos added 2 commits August 11, 2026 13:09
Propose release-mode invariant checks, secret and dependency policy,
and exact-commit admission evidence before publication.

Establish the numbered RFC directory and index the proposal for
review.
Propose repository-wide workflow contracts, gate self-consistency,
exception hygiene, and scheduled coverage-guided fuzzing.

Index the proposal alongside the release hardening RFC.
@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 33897bf4-a063-4240-abb6-71abe5546934

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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

@sourcery-ai

sourcery-ai Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Introduce two numbered documentation RFCs that define proposed release-hardening and repository-wide code-health policies, and make the RFC series discoverable via the docs index and repository-layout descriptions.

File-Level Changes

Change Details Files
Add RFC 0001 describing proposed release-mode invariants, secret scanning, dependency/licence policy, and exact-commit release admission evidence.
  • Document current gaps in release profile configuration, secret scanning, and dependency policy.
  • Specify enabling overflow checks and debug assertions in release builds with performance/size measurement requirements.
  • Define pinned Gitleaks-based secret scanning for working tree and scheduled full-history scans.
  • Describe use of cargo-audit, cargo-deny, cargo-about, and a cargo-unmaintained advisory as part of release admission.
  • Design a release-admission evidence manifest and fail-closed publication gate tied to the exact tag commit.
  • Outline phased migration, failure modes, and non-goals to keep changes additive to application behaviour.
docs/rfcs/0001-release-hardening.md
Add RFC 0002 describing a repository-wide workflow-policy validator, gate self-consistency contracts, scheduled fuzzing, health tiers, and documentation consistency checks.
  • Describe current fragmentation of workflow contracts and absence of coverage-guided fuzzing for key input surfaces.
  • Specify a deterministic validator that parses all GitHub workflows and enforces action pinning, permissions, references, and health-job policy.
  • Define gate self-consistency rules tying workflows to Make targets, nextest profiles, configuration paths, and documentation references.
  • Propose a cargo-fuzz workspace with five boundary-focused targets (manifest, Jinja, interpolation, paths, Ninja emission) and deterministic harness requirements.
  • Introduce a machine-readable health-tier and exception registry with strict ownership, expiry, and allowlist semantics.
  • Define documentation consistency checks that reconcile docs/contents, gate descriptions, and current CI/Makefile behaviour.
  • Lay out phased rollout, failure modes, alternatives, and open questions for adoption.
docs/rfcs/0002-code-health.md
Make the new RFC series discoverable in the documentation index and repository layout, and define conventions for adding future RFCs.
  • Add a 'Requests for comments' section to the docs contents index, linking RFC 0001 and RFC 0002 with short summaries.
  • Update the repository directory tree to include docs/rfcs alongside existing docs subdirectories.
  • Document docs/rfcs as the home for numbered RFCs proposing reviewable changes before they become binding decisions.
  • Specify that cross-cutting proposed changes should live under docs/rfcs and be linked from docs/contents.md upon first commit.
docs/contents.md
docs/repository-layout.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

codescene-access[bot]

This comment was marked as outdated.

@codescene-access codescene-access Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No quality gates enabled for this code.

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