Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

54 lines (39 loc) · 2.49 KB
Raw

Contributing to AYAB

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, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from main (for issues concerning the current release of the software) or from x.x.x-dev (for issues concerning the current development branch of the software).
  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 license of this repository

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

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

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
  • What actually happened
  • 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

  • Please the style of your contribution to the rest of the code
  • Python code is linted with flake8

License

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

References

This document was adapted from the open-source contribution guidelines for Transcriptase