Skip to content

Latest commit

 

History

History
92 lines (60 loc) · 3.66 KB

CONTRIBUTION.md

File metadata and controls

92 lines (60 loc) · 3.66 KB
Raw

Contributing to cochar

In order 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.
  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 (use black formatter).
  6. Issue that pull request!

What do we need

Look at the To Do list in README.

Right now most important are:

  1. Unit Tests

If you have any other suggestions feel welcome to open new issue.

Any contributions you make will be under the GNU Affero General Public License v3.0

In short, when you submit code changes, your submissions are understood to be under the same GNU AGPL v3 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

This is an example of a good bug report.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can. My stackoverflow question includes sample code that anyone with a base python setup can run to reproduce what I was seeing
  • 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

Use black formatter to style your code.

Following PEP's can help you write better and cleaner code:

  • PEP 8
  • PEP 484
  • PEP 3107

In cases where PEP's differ from black, always choose black!

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft