Skip to content

Conversation

@mamanambiya
Copy link
Collaborator

Summary

This PR establishes a comprehensive organizational structure for the TASC repository, adding standardized documentation for recommendations, architectural decisions, and governance processes. It introduces 4 GA4GH recommendations, 7 Architectural Decision Records (ADRs), and the TASC governance charter with consistent metadata formatting.

Changes

Repository Structure

  • Added /adr/ directory for Architectural Decision Records
  • Added /governance/ directory for TASC governance documents
  • Organized existing and new recommendations in /recommendations/
  • Updated main README.md with repository structure documentation and directory descriptions
  • Added .gitignore to exclude working data files

Recommendations Added

  1. GA4GH-01: API Pagination Guide - Standardizes token-based and page-based pagination approaches
  2. GA4GH-02: Service Info Type Registry Guide - Defines governance for service type registry
  3. GA4GH-03: GA4GH Product Owners - Establishes Product Owner role and software product management principles
  4. GA4GH-04: TASC Technical Specification Development - Defines four-level maturity model (Draft/Trial Use/Normative/Deprecated) and release processes

Architectural Decision Records (ADRs)

  • ADR-001: Adopt four-level maturity model for technical specifications
  • ADR-002: Require two implementations (1+ open source) for Trial Use advancement
  • ADR-003: Constrain child class maturity to not exceed parent class maturity
  • ADR-004: Use semantic versioning with maturity-based increment rules
  • ADR-005: Annotate maturity levels in JSON Schema using maturity property
  • ADR-006: Require 70% approval threshold with 1-week minimum ballot process
  • ADR-007: Support SemVer pre-release syntax for continuous development

Governance

  • Added TASC Governance and Leadership Charter defining voting membership, decision-making processes, and operational procedures

Documentation Standards

All documents now include:

  • Standardized metadata headers (Source, Recommendation ID, Title, Author, Date, Status)
  • Related GitHub issues cross-referenced
  • Abstract sections summarizing content
  • Contributors sections with proper attribution
  • Consistent formatting and structure

Related Issues

Addresses multiple GitHub issues including:

Testing

  • ✅ All markdown files validated for proper formatting
  • ✅ Internal links verified
  • ✅ Directory structure documented in main README
  • ✅ Metadata headers standardized across all documents

Additional Context

This PR implements the outcomes from TASC discussions on establishing a clear maturity model and governance framework for GA4GH technical specifications. The ADRs document the key architectural decisions extracted from the broader policy documents, providing immutable records of why specific approaches were chosen.

The repository now has a clear organizational structure that distinguishes between:

  • Rules OF TASC (governance documents)
  • Outputs FROM TASC (recommendations)
  • Decision Records (ADRs documenting architectural choices)

Ignore the data directory containing working CSV files that should not be version controlled.
- Add GA4GH-02 recommendation for service type registry governance
- Include standardized metadata header with GitHub issues
- Add abstract and contributors sections
- Update table of contents to show first-level headings only
- Add GA4GH-03 recommendation for Product Owner role definition
- Include standardized metadata header with GitHub issues
- Add abstract and contributors sections
- Establish software product management principles for GA4GH standards
- Add GA4GH-04 recommendation for maturity model and release process
- Define four-level maturity framework (Draft, Trial Use, Normative, Deprecated)
- Include standardized metadata header with GitHub issues
- Add abstract and contributors sections
- Establish versioning and advancement criteria
- Add governance charter defining TASC structure and operations
- Include standardized metadata header with GitHub issues
- Add abstract and contributors sections
- Define voting membership, decision-making process, and operational procedures
- Add 7 ADRs documenting key technical decisions from TASC Technical Specification Development policy
- ADR-001: Adopt four-level maturity model (Draft/Trial Use/Normative/Deprecated)
- ADR-002: Require two implementations for Trial Use advancement
- ADR-003: Constrain child class maturity to parent class level
- ADR-004: Use semantic versioning with maturity-based rules
- ADR-005: Annotate maturity in JSON Schema
- ADR-006: Require 70% approval for community ballot advancement
- ADR-007: Allow SemVer pre-release syntax for continuous development
- Include ADR template and README index
- Add Repository Structure section to table of contents
- Add directory tree visualization showing all folders
- Add descriptions for /adr/, /governance/, /recommendations/, /drafts/, /service-info/
- Cross-reference to adr/README.md for ADR details
- Update ADR link to point to local adr/ directory
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant