Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (45 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

66 lines (45 loc) · 2.09 KB

Contribution Guidelines

GitHub is used to host code, to track issues and feature requests, as well as accept pull requests.

Contributing

Planning

Contributions are very welcome. Please start with a planning step before working on code and submitting pull requests:

  • Create an issue in which you describe your proposed change in detail:
    • Purpose and use case
    • Architecture (how will it work?)
    • Implementation (what will the code look like?)
  • A maintainer will then look at your proposal and get back to you and either:
    • Approve
    • Request changes
    • Reject
  • Once the proposal has been approved, please continue with the next step (pull request).

Pull Requests

Changes to the codebase are made through pull requests (PRs). Procedure:

  • Fork the repo and create your branch from main.
  • Make your changes.
  • Make sure your code lints (using scripts/lint).
  • Test your contribution (use scripts/test; aim to keep coverage ≥ 99%).
  • Update the documentation.
  • Issue that pull request!

Bug Reporting

Report a bug by opening a new issue.

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)

Coding Style

This repository uses Ruff for formatting and linting.

  • Format and lint locally with:

    ./scripts/lint

  • The linter enforces import sorting and common correctness/style rules.

Development Environment

This integration comes with a devcontainer, easy to use with Visual Studio Code. See this blog post for helpful information on how to get started with Home Assistant integration development.

License

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