ci: validate RFC contents in check-rfc - #534
Open
filvecchiato wants to merge 4 commits into
Open
Conversation
TarikGul
approved these changes
Aug 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
validate-rfcreads the RFC documents a pull request touches. A newly added RFC needstitleandownerfrontmatter, a## Summary, a## Motivation, and a section covering the approach; every touched RFC must be free of unedited template text and ofTODO,TBDorFIXME. Edits to existing RFCs are exempt from the structural checks, several predate the template. Numbering is not checked, so an unnumbered draft passes andnumber-rfc.ymlstill assigns the number on merge. The diff runs against an explicitgit merge-base.Implementation is tracked on the RFC's issue, which carries a task per host alongside the Rust one, so an RFC document lands without
rust/crates/truapi/changes.docs/rfcs/0001-template.mdis the single template, in the shape therfcskill drafts: Summary, Motivation, Approach, Trade-offs, Open questions.CONTRIBUTING.md, the skill, and the_index.mdrow for 0001 match it.Three names for the design section are accepted —
Detailed Design,Explanation,Approach— because the corpus holds all three. Settling on one is a separate cleanup.Verified in a throwaway repo across nine cases: unnumbered, skill-shaped and Fellowship-shaped RFCs pass; missing frontmatter, missing sections, a verbatim template copy and a
TODOfail; index-only and template-only changes are skipped.