projecthydra-labs.github.io

ProjectHydra Labs

Follow me on GitHub

Project Hydra Labs: Promotion Process

Guidelines for Promotion to Project Hydra from Labs

  1. Version >= 1.0

  2. Good unit test coverage measured by community (e.g. 100% or 75% of what’s important)

    1. uses CI (Travis-CI)

    2. uses Coverage tool (coveralls or simplecov)

  3. Documentation

    1. LICENSE file, Apache 2 (or compatible)

    2. README.md

      1. Statement of purpose

      2. Basic install steps

      3. Identify any volatile/experimental features

    3. How to contribute -> CONTRIBUTING.md

    4. How/Who to contact for help -> push out to all gems like CONTRIBUTING.md

    5. Known issues documented in github Issues tickets (not just listed in text)

    6. Tutorial / Walkthrough / Example usage

  4. Resolve TODO items in documents and remove them

  5. Community use by three or more institutions

  6. In active use for six months

  7. Show compatibility with current Rails versions and other dependencies, when was it last tested; note compatibility with prior versions when available

    1. Compatability can be specified in the gemspec(s) or verified via CI matrix

  8. All Contributors should have signed Hydra Contibutor License Agreement (CLA)

  9. Hierarchy of promises asserted in clearly defined acceptance tests

 

Mechanism for Promotion

  1. As needed or requested, Gems are reviewed for promotion / graveyard

    1. A small group should code review the candidates

    2. Group of contributors commits to upgrade path

    3. Goal to limit movement from ProjectHydra to graveyard (Path to graveyard should be from Labs)

  2. List sent to Hydra list for approval / confirmation