Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 1.3 KB

Contributing to InSilicoSeq

Thank you for your interest in our software ❤️ 🎉

Conduct

We are committed to providing a friendly, safe and welcoming environment for all. If you wish to contribute, you are expected to adhere to a code of conduct

How to contribute

This project is still at an early stage and open to suggestions of any kind. Chat with us by opening and issue or fork the repository and open a pull request

Coding guidelines

  • Please adhere to PEP8
  • The docstrings should follow the Google style guide
  • Your pull request should pass the unit tests. New code/functionality should come with a test.
  • Ideally a pull request should solve one problem or add one functionality.

Set up your dev environment

The following steps assume you have python >= 3.5 and pipenv installed.

  1. Fork the repository and clone your fork

  2. Install the development dependencies

pipenv install --dev

  1. Make your changes.

  2. You can test the software with

pipenv run capture

and run the tests with

pipenv run test
  1. Make your pull request 🎉