Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 2.4 KB
Raw

Contributing

Guidelines

  • Node 18 LTS: Homebridge projects have (if not stated otherwise) a minimum Node version requirement of 18.15.0. Pull requests MUST NOT require a Node version greater than that unless the feature is enabled/backported via [TypeScript][link-typescript]. If a higher version requirement may be justified you SHALL include your reasoning in the pull request discussion.

  • Coding Standard: Linting errors are checked by ESLint.
    Keeping a consistent style throughout the codebase keeps the cognitive load low for all contributors and keeps the code style homogeneous.

  • Add tests: All pull requests SHOULD include unit tests to ensure the change works as expected and to prevent regressions. Any pull request containing a bug fix SHOULD include a regression test for the given fix.

  • Document any change in behaviour: Homebridge projects rely on inline documentation powered by TypeDoc.
    Additionally, some projects MAY rely on GitHub Wikis which MIGHT need to be updated.

  • Consider our release cycle: Before creating any pull request, please read through our concept for release cycles. Most notably the section explaining our Git Workflow.

  • One pull request per feature: If you want to do more than one thing, send multiple pull requests. Otherwise, your pull request could be rejected.

  • Send coherent history: Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please rebase or squash them before submitting.

Running tests

In order to contribute, you'll need to checkout the source from GitHub and install dependencies using npm:

git clone https://github.com/homebridge/<PROJECT>.git
cd <PROJECT>
npm install
npm test

Reporting a security vulnerability

See SECURITY.md

Happy coding!