Skip to content

Latest commit

 

History

History
94 lines (64 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

94 lines (64 loc) · 3.02 KB

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 main.
  2. If you've changed something, update the documentation.
  3. Make sure your code lints (using scripts/lint).
  4. Test you contribution.
  5. Issue that pull request!

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.

Use a Consistent Coding Style

Use the configured linter to check your code, and make sure it follows the project conventions.

Local development environment

Visual Studio Code is the recommended code editor for this project. This project includes a devcontainer configuration for an easy to use and consistent development environment. With this container you will have a stand alone Home Assistant instance running and already configured with the included configuration.yaml file.

Dependency management

Dependencies are managed via Poetry. This will be managed for you automatically if using the dev container. If you wish to run outside of a dev container, you will need to install your dependencies manually:

pip install poetry~=1.7
poetry install

Running tests

Use ./scripts/test to invoke the test runner. You must be within the virtual environment where project dependencies are installed:

poetry run ./scripts/test

Alternatively:

poetry shell
# you now have a shell within the virtual env
./scripts/test

Linting

Use ./scripts/lint to invoke the project linter. You must be within the virtual environment where project dependencies are installed:

poetry run ./scripts/lint

Alternatively:

poetry shell
# you now have a shell within the virtual env
./scripts/lint

License

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