Skip to content
This repository has been archived by the owner on Oct 18, 2021. It is now read-only.

Latest commit

 

History

History
33 lines (17 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

33 lines (17 loc) · 2.08 KB

Introduction

Hi there, thank you for considering contributing to pygpseq to help us make our code a better version of itself!

pygpseq is an open source project, and as such any kind of contribution is welcome! There are many ways to contribute, from improving the code, the documentation, submitting bug reports, requesting new features or writing tutorials or blog posts.

Ground Rules

To see what kinds of behaviour are ucceptable when contributing to pygpseq, please refer to our code of conduct.

Getting started

We host pygpseq on github, where we also track issues and feature requests, as well as accept pull requests.

Please, note that any contributions you make will be under the MIT Software License. In other words, all your submissions are understood to be under the same MIT License that covers the pygpseq project. Feel free to contact us if that's a concern.

How to submit a contribution

To process code change, we follow the Github Flow. All code changes to our master branch happen through pull requests. We actively welcome your pull requests!

How to report a bug

If you want to reporte a bug, please use the github issue tracker and follow the issue template that should automatically load up.

How to suggest a feature or enhancement

If you would like to see a new feature implemented in pygpseq, or to have an already existing feature improved, please use the github issue tracker and follow the template that should automatically load up.

Style your contributions

We like to have pygpseq code styled according to the following style guides. Although we might be inconsistent sometimes (that's a bad habit!), we tend to go through the code and re-format it every once in a while.