How webkit/standards-positions works
Project type and purpose
• Project type: A small “infrastructure” or “content‐generation” tool that lives in a GitHub repository.
• Purpose:
– Host issue templates and track community proposals on web specs via GitHub Issues.
– Provide a summary (JSON) of WebKit’s positions for publication on webkit.org.
– Automate (via a Python script) the transformation of raw issue data into consumable JSON.
File structure
Top-level items:
• .github/ISSUE_TEMPLATE/request-for-position.yml
• README.md
• summary-data.json
• summary.json
• summary.py
Key observations:
– .github/ISSUE_TEMPLATE contains the form users fill out when filing a new proposal issue.
– summary-data.json likely holds raw or intermediate data.
– summary.json is the final, published summary.
– summary.py is the transformation script.
README for additional insights
• Describes the workflow around filing issues, adding position labels, and eventually consuming the summary JSON on webkit.org.
• No mention of CI workflows or external services beyond GitHub and the eventual web publication.
Main components & their relationships
– Contributor (files a new issue using the request-for-position template)
– WebKit Maintainer (labels issues, reviews, closes issues)
– ISSUE_TEMPLATE
– Issues database
– summary.py
– summary-data.json (input)
– summary.json (output)
c. summary.py (Python transformation pipeline):
– Reads summary-data.json
– Applies any filtering/aggregation logic
– Writes summary.json
d. Downstream Consumer:
– webkit.org Standards Positions page (pulls summary.json)
• Contributor → GitHub Issues (via request-for-position.yml)
• Maintainer → Issues (labels, comments, closes)
• Maintainer/CI (or local dev) → Runs summary.py → reads summary-data.json → writes summary.json
• webkit.org page → Fetches summary.json
Architectural patterns & design principles
• Single-responsibility: summary.py only transforms data; issues only track positions.
• Data pipeline: raw data (JSON) → processing script → final JSON.
• Source-of-truth: GitHub Issues serve as the canonical input.
Technologies & frameworks involved
• Python (summary.py)
• JSON (summary-data.json, summary.json)
• GitHub platform (Issues, Templates, Repository)
• Web server (webkit.org) for final consumption