How filecoin-project/fips works
Project Type and Purpose
• This is an open-source governance repository (“Filecoin Improvement Protocol”) that defines the process and houses all Filecoin Improvement Proposals (FIPs), Filecoin Recovery Proposals (FRCs), templates, and related resources.
• There is minimal executable code; most files are Markdown specifications, governance documents, and GitHub Actions workflows for CI.
File Structure Analysis
• Top-level directories:
• .github/ – GitHub Actions workflows and templates for PR labeling and testing.
• FIPS/ – All numbered FIP markdown files.
• FRCs/ – All numbered FRC markdown files.
• Community Governance Calls/ – Agendas and notes for community calls.
• resources/ – Supplementary PDF/Go/ipynb reference materials.
• templates/ – Template for new proposal.
• Top-level files: README.md, mission.md, proposing.md, FUNDING.json.
• CI files: .github/workflows/*.yml and supporting Python scripts.
README Insights
• Describes the governance process: proposal submission, review, classification (FTP, FOP, FRP).
• Links to external specification repo (specs) where the protocol spec is updated.
• Lists all FIPs/FRCs with status, tying the Markdown content to community and technical steering.
a. Main Components
• Repository Content (Docs Layer): FIPS, FRCs, templates, community call notes, resources.
• CI/CD Layer: GitHub Actions workflows (labeling, tests).
• Contributors (Actors): Community members, authors, reviewers, stewards.
• External Services: GitHub hosting, GitHub Actions runners, external specs repo.
b. Relationships & Interactions
• Contributors submit PRs → CI runs workflows → Labeler & test suites validate → Maintainers review → Merge.
• Merged FIPs trigger downstream updates in the Filecoin Specs repository and community calls.
c. Architectural Patterns
• Content-centric repo with a GitOps style workflow.
• A “documentation pipeline” where PR → CI → review → merge → external sync.
d. Key Technologies
• Markdown for spec files.
• GitHub Actions (.yml, Python labeler).
• GitHub as VCS and issue/PR tracking.
• External spec repository integration via hyperlinks.