Contribution Standards

Last updated:

Showcase Submissions

To submit a tool to the consortium showcase, your project must meet the following requirements:

  • Working tool — the project must be functional, not just a stub or placeholder
  • README — a clear README explaining what the tool does, how to install or use it, and any prerequisites
  • License — an open-source license (MIT, Apache 2.0, GPL, etc.)
  • Repository URL — a public Git repository

Quality Bar

All showcase entries should meet a minimum quality standard:

  • Must build — the project should build successfully from a clean checkout
  • Must have documentation — at minimum, a README with setup instructions
  • Should have tests — automated tests are strongly encouraged; projects with no tests may receive lower priority in review

Submission Process

  1. Fork the consortium website repository.
  2. Create a new YAML file in src/data/showcase/ with your tool’s details (see _example.yaml for the format).
  3. Open a pull request with a brief description of your tool.
  4. A Council member will review your submission.
  5. CI must pass before the PR can be merged.

Review Criteria

Council reviewers will check:

  • Does the tool meet the requirements listed above?
  • Does it comply with the IP Policy?
  • Is the YAML file correctly formatted?
  • Does the description accurately represent the tool?

Maintenance

To keep the showcase useful and trustworthy:

  • Tools with no repository activity for 6 months will be marked as archived.
  • Archived tools remain in the showcase but are clearly labeled.
  • Authors can request reactivation at any time by demonstrating renewed activity.

Data Contributions

For contributions to shared data packages (such as 40kdc-data):

  • All data must validate against the published schemas.
  • Submit changes via pull request.
  • A Council member must review and approve.
  • CI validation must pass before merge.