mirror of
https://github.com/vacp2p/roadmap.git
synced 2026-01-08 15:23:55 -05:00
845d6b8dcd
## Summary - Introduce a standalone Python roadmap validator with a CLI entry point, modular validation pipeline, and GitHub Actions wiring so roadmap content can be linted locally and in CI. - Provide reusable validation primitives for path resolution, front-matter parsing, identity checks, task parsing, catalog enforcement, and template adherence. - Document usage, configuration, and workflow behaviour to make the validator approachable for contributors. ## Validator Details - **Core tooling** - Added the `tools/roadmap_validator/` package with `validate.py` (CLI), `validator.py` (orchestration), and helper modules (`tasks.py`, `identity.py`, `paths.py`, `constants.py`, `issues.py`). - CLI supports directory/file targets, skips default filenames, emits GitHub annotations, and integrates optional substring filtering - README explains features, environment variables, and development guidance. - **Catalog and template enforcement** - `catalog.py` verifies each allowed content unit has `index.md` and `preview.md`, confirms roadmap entries appear under the proper quarter/area, and flags stale or missing links. - `templates.py` enforces template basics: front matter completeness, `## Description` ordering/content, template placeholder cleanup, and task section detection. - **Task validation** - `tasks.py` checks required metadata (`owner`, `status`, `start-date`, `end-date`), date formats, populated descriptions/deliverables, TODO markers, tangible deliverable heuristics, and `fully-qualified-name` prefixes. - **Workflow integration** - `.github/workflows/roadmap-validator.yml` runs the validator on pushes and manual dispatch, installs dependencies, scopes validation to changed Markdown, and surfaces findings via GitHub annotations. ## Existing Roadmap Updates - Normalised 2025q4 commitments across Web, DST, QA, SC, and other units by filling in missing descriptions, deliverables, schedule notes, recurring task statuses, and maintenance tasks. - Added tasks where absent, removed remaining template placeholders, aligned fully qualified names, and ensured roadmap files conform to the new validator checks. ## Testing ```bash python tools/roadmap_validator/validate.py *2025q4* ``` CI: `Roadmap Validator` workflow runs automatically on pushes/dispatch. --------- Co-authored-by: kaiserd <1684595+kaiserd@users.noreply.github.com>
5.8 KiB
5.8 KiB
title, tags, draft, description
| title | tags | draft | description | |||
|---|---|---|---|---|---|---|
| Logos Contributions Portal |
|
false | Development of Logos Contribute, a contribution hub that recognizes open source contributors and helps new developers make their first contributions to strengthen the Logos ecosystem. |
vac:web:ift:2025q4-logos-contributions-portal
Description
This commitment involves developing Logos Contribute, a comprehensive contribution hub that recognizes open source contributors and helps new developers make their first meaningful contributions to the Logos ecosystem. The portal serves as a critical component of the volunteer-driven, open source community building strategy, showcasing contributor activity, providing curated resources, and offering clear pathways for community engagement.
The Logos Contribute portal directly supports the quarterly KPIs by:
- External Developer Contributions: Tracking and encouraging 10% month-over-month increase in external developers contributing to the Logos technology stack
- Community Activation: Supporting the 10% activation benchmark for new community members through clear contribution pathways
- Hacktivation Barriers: Providing 10% increase in tagged lower tasks by CCs in GitHub repositories
- Community Retention: Helping retain contributors through recognition and engagement systems
Key Features Include:
- Contributor Directory: Displays GitHub usernames, profile links, contribution counts, and contribution history
- Individual Profiles: Detailed pages with contribution details and complete contribution lists
- Search Functionality: Search by GitHub username or repository name
- Contribution Guidelines: Clear instructions and best practices maintained on GitHub
- Contributor Ladder: Structured growth path where contributors earn recognition, responsibilities, and privileges (from leaderboard presence and swag to reviewer rights and governance roles) as they progress through ranks
- Contributors Leaderboard: Seasonal and all-time rankings highlight active contributors across coding, design, documentation, translation, etc.
- Proposal Submission: Form allowing developers, writers, designers, and others to submit proposals
- GitHub Issues Integration: Display curated issues from contribute.logos.co repository
Alignment with IFT Narratives:
- Digital Liberties: Supporting open source development that defends civil liberties through community-driven innovation
- Community Co-creation: Enabling user-generated content and community participation through contribution recognition
- Accessibility: Making open source contribution accessible not only to developers of all skill levels, but also to designers, writers, translators, community builders, and event organizers
- Brand Coherence: Strengthening Logos' position as a hub for movement-building volunteers and collaborators
Task List
Contributor Directory
- fully qualified name:
vac:web:ift:2025q4-logos-contributions-portal:contributor-directory - owner: JulesFiliot
- status: in progress (90%)
- start-date: 2025/08/11
- end-date: 2025/10/31
Description
Build the landing directory that lists active contributors with GitHub stats and quick links to their work.
Deliverables
- PRs/Issues/Docs/Reports
Contributor Profiles
- fully qualified name:
vac:web:ift:2025q4-logos-contributions-portal:contributor-profiles - owner: JulesFiliot
- status: in progress (90%)
- start-date: 2025/08/11
- end-date: 2025/10/31
Description
Implement profile pages that surface individual contribution history, badges, and impact summaries.
Deliverables
- PRs/Issues/Docs/Reports
Contribution Guidelines
- fully qualified name:
vac:web:ift:2025q4-logos-contributions-portal:contribution-guidelines - owner: jinhojang6
- status: in progress (90%)
- start-date: 2025/09/25
- end-date: 2025/10/31
Description
Author and publish contributor onboarding and etiquette guidelines to sit alongside the portal.
Deliverables
- PRs/Issues/Docs/Reports
Display Github issues
- fully qualified name:
vac:web:ift:2025q4-logos-contributions-portal:github-issues - owner: JulesFiliot
- status: in progress (90%)
- start-date: 2025/09/08
- end-date: 2025/10/31
Description
Integrate curated GitHub issues into the portal so newcomers can quickly find actionable tickets.
Deliverables
- PRs/Issues/Docs/Reports
Use BI team's Github Data
- fully qualified name:
vac:web:ift:2025q4-logos-contributions-portal:bi-data - owner: JulesFiliot
- status: in progress (20%)
- start-date: 2025/09/08
- end-date: 2025/10/31
Description
Plumb BI-provided GitHub datasets into the portal to power contributor metrics and trend charts.
Deliverables
- PRs/Issues/Docs/Reports
Leaderboard
- fully qualified name:
vac:web:ift:2025q4-logos-contributions-portal:leaderboard - owner: JulesFiliot
- status: in progress (80%)
- start-date: 2025/08/20
- end-date: 2025/10/31
Description
Implement seasonal and all-time leaderboards with sorting that highlights high-impact contributors.
Deliverables
- PRs/Issues/Docs/Reports
Tier & Scoring
- fully qualified name:
vac:web:ift:2025q4-logos-contributions-portal:tier-scoring - owner: jinhojang6
- status: in progress (50%)
- start-date: 2025/08/20
- end-date: 2025/10/31
Description
Define the tier logic and scoring rules that map contributor activity into the recognition ladder.
Deliverables
- PRs/Issues/Docs/Reports
Proposals
- fully qualified name:
vac:web:ift:2025q4-logos-contributions-portal:proposals - owner: jinhojang6
- status: done
- start-date: 2025/09/20
- end-date: 2025/10/31
Description
Launch the proposal submission flow so volunteers can pitch work or request support directly in the portal.
Deliverables
- PRs/Issues/Docs/Reports