Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

24 lines (16 loc) · 1.87 KB

Request for contributions

We welcome new contributors. We have an active set of users and we are providing them with new analysis functionality to help them in their investigations into genetic diseases. We'd love for you to join us. Take a look at our pitch.

We have a list of open issues and a need for improved performance and test coverage.

Relevant skills include bioinformatics, genetics, Python, HTML, CSS, JavaScript, Ajax, databases.

If you'd like to chat about how you might contribute, please contact Nikolas Pontikos.

How to contribute

Automated build and test

We use Travis CI to build and test all commits and follow the practices of continuous integration. Our master branch must always be in a working state. Only pull requests that have a passing build will be considered for merging in to master. Broken builds on master branch must be fixed immediately (by reverting the commit if necessary).

Please include tests with your pull request. We use Coveralls to monitor and analyse test coverage.

We also run Scrutinizer's static analysis.

Code reviews

We review each other's code before merging a pull request in to the master branch. Please select reviewer from the menu when setting up your pull request.

Communication

  • We have a Slack team for general discussions. Please get in touch with Nikolas Pontikos for access.
  • GitHub issues are the primary way we communicate about specific proposed changes.
  • Use Github pull requests for code reviews and to discuss proposed code contributions.