How reactjs/rfcs works
Project Type and Purpose
• This is an open‐source RFC documentation repo.
• Purpose: provide a controlled “Request for Comments” process for React feature proposals, maintain templates & RFC texts, and automate checks via GitHub.
File Structure
• .github/ISSUE_TEMPLATE/: holds GitHub issue‐template config.
• 0000-template.md: blueprint for new RFCs.
• text/: contains every RFC in markdown, named with RFC numbers.
• Root files: README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE.md.
• No code modules, no server‐side execution—pure content and CI config.
README
• Describes the RFC lifecycle, contribution guidelines, CLA requirement, review process, and inspiration.
Main Components
a. Contributors (external developers)
b. GitHub RFCs Repository
• Content subcomponents:
• Issue templates (.github/ISSUE_TEMPLATE)
• RFC template (0000-template.md)
• RFC texts (text/*.md)
• Governance docs (CONTRIBUTING.md, CODE_OF_CONDUCT.md, etc.)
c. CI/CD Automation (GitHub Actions or bots that ensure CLA signed, lint RFC markdown, validate links)
d. Reviewers/Maintainers (React Core team members)
e. Merge & Publish
• Once RFC is merged → becomes “active”
• (Optional) GitHub Pages or external docs site generation
Relationships & Interactions
• Contribution Flow:
Contributor → Fork & Clone → Create/Edit text/000X-*.md → Push → GitHub PR → CI checks → Maintainer review → Merge
• Automation Flow:
On PR open/update → Trigger GitHub Actions → Validate CLA status, markdown lint, template compliance → Report status back to PR
• Post‐Merge:
Merged RFC remains in text/; may trigger site generation or simply acts as repo content.
Architectural Patterns/Principles
• Single Source of Truth: All RFC docs live in one git repo.
• Standardized Template: 0000-template.md enforces consistent structure.
• Automated Checks: CI to maintain quality and CLA compliance.
• Review‐Driven Workflow: PRs generate discussion & votes before activation.
Technologies & Frameworks
• Git & GitHub (issues, PRs, Actions)
• Markdown for RFCs
• YAML for CI and issue‐template config