Skip to content
This repository has been archived by the owner on Dec 12, 2022. It is now read-only.

Latest commit

 

History

History
32 lines (24 loc) · 1015 Bytes

CONTRIBUTING.md

File metadata and controls

32 lines (24 loc) · 1015 Bytes
Raw

Contributing to Transcriptase

We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

Report bugs using Github's issues

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Use a Consistent Coding Style

  • 4 spaces for indentation
  • camelCase for variables' names
  • use correct access modifiers in classes for methods
  • place imports at the top
  • create constants in config.py file

License

By contributing, you agree that your contributions will be licensed under GNU GENERAL PUBLIC LICENSE Version 3.