Contributing to Transcriptase
=============================
We love your input! 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.

We Use `Github Flow <https://guides.github.com/introduction/flow/index.html>`_, So All Code Changes Happen Through Pull Requests
--------------------------------------------------------------------------------------------------------------------------------
Pull requests are the best way to propose changes to the codebase (we use `Github Flow <https://guides.github.com/introduction/flow/index.html>`_). We actively welcome your pull requests:

1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

Any contributions you make will be under the GNU General Public License (`GPL <https://www.gnu.org/licenses/gpl-3.0.en.html>`_)
-------------------------------------------------------------------------------------------------------------------------------
In short, when you submit code changes, your submissions are understood to be under the same GPL-3.0 license that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's `issues <https://github.com/TodoLodo/cod-python-api/issues>`_
--------------------------------------------------------------------------------------------
We use GitHub issues to track public bugs. Report a bug by `opening a new issue <https://github.com/TodoLodo/cod-python-api/issues/new>`_

Write bug reports with detail, background, and sample code
----------------------------------------------------------
**Great Bug Reports** tend to have:

- A quick summary and/or background
- Steps to reproduce
  - Be specific!
  - Give sample code if you can.
- 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)

People *love* thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style
-----------------------------

* 4 spaces or tabs for indentation
* Use reasonable and understandable variable names
* Use proper error handling
* Add comments where necessary 
* You can try running `pylint example.py` for style unification

License
-------
By contributing, you agree that your contributions will be licensed under its GPL-3.0 license.

----------------------------------------------------------------------------------------------------------------------------------------------------------------

References
----------
This document was adapted from a gist by `briandk <https://github.com/briandk>`_
