The additional information presented here are guidelines for issues, branches, commits, and pull requests. Suggested changes to this repo can be initiated as Issues or Pull Requests to allow for discussion and review.
Issues are for discussion of bug reports, suggested changes and feature requests. Please refer to our issue templates for guidance on what content to include in an issue. When creating an issue, use sentence case for the issue title and avoid the use of periods at the end of titles. Before posting a new issue, please check that your issue is not duplicative to an already open issue.
Additional information about issues can be found at GitHub Issues in GitHub docs.
Branches are used for versioning and feature additions. Feature branches must be associated with an open issue describing the desired feature, and named after the issue as [issue number]-[short description].
More information can be found at About branches and Managing branches in GitHub docs.
Pull Requests (PRs) must be created for all new
features and changes to the codebase and should target the main branch. Please refer to our PR template for guidance on what content to include in a PR. PR titles must reflect the issue associated with the PR.
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.
Additional information about PRs can be found at Pull requests in GitHub docs.
Open issues and PRs are reviewed and triaged in our QC of WGS calls. PRs must be reviewed and approved by at least one Product Maintainer (TBD) before they are merged.
We use semantic versioning- this will determine if your proposed changes impact a major or minor release.