Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

33 lines (19 loc) · 2.65 KB
Raw

CONTRIBUTING

This schema is developed by the Cloud Work Stream of the Global Alliance for Genomics and Health.

Semantic Versioning

We use semantic versioning for WES, this will determine if your proposed changes impact a major or minor release.

Suggesting Changes

Suggested changes to this schema can be initiated as Issues or Pull Requests to allow for discussion and review.

Even those with write access to the main repository should in general create pull request branches within their own forks. This way when the main repository is forked again, the new fork is created with a minimum of extraneous volatile branches.

To facilitate review of external pull requests, users are encouraged to activate Travis CI to monitor the build status (documentation, Swagger UI) of their fork. By following the documentation for deployment to GitHub Pages and adding a $GITHUB_TOKEN environment variable to their repo configuration, pushes to the forked repo should be viewable relative to https://[user-or-org].github.io/workflow-execution-service-schemas/preview/<branch>/:

  • https://[user-or-org].github.io/workflow-execution-service-schemas/preview/<branch>/docs/
  • https://[user-or-org].github.io/workflow-execution-service-schemas/preview/<branch>/swagger-ui/
  • https://[user-or-org].github.io/workflow-execution-service-schemas/preview/<branch>/swagger.json
  • https://[user-or-org].github.io/workflow-execution-service-schemas/preview/<branch>/swagger.yaml

Providing this base URL in the pull request comment is appreciated, but not required.

If a security vulnerability is identified with the specification please send an email to [email protected] detailing your concerns.

Approving Changes

pre-WES v1.0.0 / Testbed Voting Procedure

Changes for the release are to be approved by four developers - Marcus Kinsella (HCA), Jeff Gentry (Broad Institute), James Eddy (Sage Bionetworks), Peter Amstutz (Veritas Genetics). In addition they must not be overridden by the Cloud Work Stream Leads, Brian O'Connor and David Glazer.

post WES v1.0.0 Voting Procedure

GA4GH has a number of Driver Projects. Each of those associated with the Cloud Work Stream will nominate a representative. None of these may vote against a proposed change for it to proceed. In addition they must not be overridden by the Cloud Work Stream Leads, Brian O'Connor and David Glazer.