Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (43 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

66 lines (43 loc) · 2.07 KB
Raw

Contribution guidelines

Contributing to this project should be 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

Github is used for everything

Github is used 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.

  1. Fork the repo and create your branch from master.
  2. If you've changed something, update the documentation.
  3. Make sure your code lints (ruff check .).
  4. Run the test suite (pytest) and ensure 100% coverage is maintained.
  5. Issue that pull request!

Development environment

This project includes a devcontainer for VS Code. Opening the project in the container gives you a ready-to-go environment with all dependencies installed.

Running tests

pytest tests/ --cov=custom_components/ooler --cov-report=term-missing

The project requires 100% test coverage. New code must include tests.

Linting

ruff check .
ruff format --check .

Any contributions you make will be under the MIT Software License

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.

Report bugs using Github's issues

GitHub issues are used 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
  • 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.

License

By contributing, you agree that your contributions will be licensed under its MIT License.