Skip to content

Latest commit

 

History

History
29 lines (24 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

29 lines (24 loc) · 1.64 KB
Raw

Contributing to Varcode

Varcode is open source software and we welcome your contributions. This document should help you get started contributing to Varcode.

Filing Issues

If you find any bugs or problems while using Varcode or have any feature requests, please feel free to file an issue against the project. When doing so, please follow the guidelines below:

To report any bugs, issues, or feature requests, please open an issue Please check the current open issues to see if the request already exists If you are filing a bug report, please describe the version of Varcode, PyEnsembl, and Python being used. If your problem involves a particular genomic variant, please include that variant and its corresponding reference genome (e.g. "GRCh37 1:384747 AAC>T").

Coding Guidelines

  • Varcode is written in Python and adheres to the PEP8 style guidelines.
  • Contributions should come in the form of GitHub pull requests.
  • New features should start with a GitHub issue explaining their scope and rationale.
  • If the work is based on an existing issue, please reference the issue in the PR.
  • All new code should be accompanied by comprehensive unit tests.
  • If the PR fixes or implements an issue, please state "Closes #XYZ" or "Fixes #XYZ", where XYZ is the issue number.
  • Please ensure that your code works under Python >= 3.7.

Licensing

Varcode is licensed under the Apache 2.0 license. Your code is assumed to be as well.