Thanks for your interest in this project! The goal is to bring fast, reliable, and trouble-free open-source cleaning processes to all communities. We love your input! We want to make every contribution to this project as transparent and effortless as possible. Please note that we have a code of conduct that we need to follow moving forward in all your interactions with the project.
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We use github to host code, to track issues and feature requests, as well as accept pull requests.
Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:
- Fork the repository and create your branch from
main. - If you've added code that should be tested, add tests.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
We use GitHub issues to track public bugs.
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)
You can check the PEP 8 Style Guide for more information about a good coding style. It's important to respect and follow it up to keep good practices. If it's difficult for you please, take in consideration use flake8.
In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.
This document was adapted from the open-source contribution guidelines for Facebook's Draft