How electron/rfcs works
Project type and purpose
• This is an open-source process repository (“electron/rfcs”) whose primary function is to collect, discuss, and version “Request for Comments” documents for the Electron project. It is not a runtime application but rather a workflow/document-management tool built on top of GitHub.
File structure
• Top-level files and folders:
• .github/ – workflow definitions (semantic.yml) and CODEOWNERS (who must approve).
• 0000-template.md – the base RFC template.
• text/ – contains the actual RFC proposal Markdown files (0004-api-history-schema.md, etc.).
• README.md – describes the RFC process.
• LICENSE.md – license for the repository.
• The structure shows a single-repo, GitHub-driven workflow with:
• A template for new proposals
• A folder for active proposals (text/)
• CI checks via GitHub Actions for semantics, versioning, formatting, etc.
README for additional insights
• Defines the stages of an RFC (Proposed, Pending Comment, Active, Abandoned, Completed, Declined)
• Explains how to fork, author, review, and merge RFCs
• Describes human actors (contributors, API WG/maintainers) and automated checks
a. Main components
• Community/Contributors: fork & author RFCs
• GitHub Platform: hosting the repo, issues/PRs, Actions runner
• RFC Repository:
• 0000-template.md (blueprint)
• text/ folder (markdown RFCs)
• images/ folder (assets)
• .github/workflows/semantic.yml (CI checks)
• .github/CODEOWNERS (review rules)
• Maintainers / API Working Group: review, label, merge, and manage status transitions
• Electron/electron Repo: target for implementation PRs once an RFC is Active
b. Relationships & interactions
1. Contributor forks repo → copies 0000-template.md → creates text/0000-*.md → opens PR.
2. GitHub Actions (semantic.yml) runs semantic-versioning, formatting, or metadata checks.
3. CODEOWNERS file triggers automatic review requests to maintainers.
4. Maintainers review PR → change status label (Proposed → Pending Comment → Active, etc.) → merge or close.
5. Once “Active,” contributor or maintainer opens an implementation PR in electron/electron; upon merge, the RFC is marked “Completed.”
c. Architectural patterns & design principles
• GitOps/CI-driven: all process steps (lint, version check, labeling) automated through GitHub Actions.
• Template-Based Extensibility: new RFCs simply follow the filesystem convention in text/.
d. Key technologies & frameworks
• GitHub Actions (.github/workflows/semantic.yml)
• Markdown files in a conventional directory layout
• CODEOWNERS (GitHub feature) for mandatory reviewer assignment
• Standard Git/GitHub protocol (fork → PR → review → merge)
Elements
• Clear labels for each actor and component (e.g., “Contributor,” “GitHub Actions,” “Maintainers,” “RFC Repo”)
Detail is key
• Both manual steps (forking, review) and automated steps (CI checks)
• Don’t over-modularize: break the process into every meaningful component (template, CI, reviewers, repo, external implementation repo) to give maximum clarity
• Transitions—e.g., “2-week comment period” between Pending Comment → Active