22
33##Guidelines
44
5- * ** Node 18 LTS:** Homebridge projects have (if not stated otherwise) a minimum Node version requirement of 18.15.0.
5+ - ** Node 18 LTS:** Homebridge projects have (if not stated otherwise) a minimum Node version requirement of 18.15.0.
66 Pull requests MUST NOT require a Node version greater than that unless the feature is
7- enabled/backported via[ TypeScript] [ link-typescript ] . If a higher version requirement may be justified
7+ enabled/backported via[ TypeScript] [ link-typescript ] . If a higher version requirement may be justified
88 you SHALL include your reasoning in the pull request discussion.
99
10- * ** Coding Standard:** Linting errors are checked by[ ESLint] [ link-eslint ] .
10+ - ** Coding Standard:** Linting errors are checked by[ ESLint] [ link-eslint ] .
1111 Keeping a consistent style throughout the codebase keeps the cognitive load low for all
1212 contributors and keeps the code style homogeneous.
1313
14- * ** Add tests:** All pull requests SHOULD include unit tests to ensure the change works as
14+ - ** Add tests:** All pull requests SHOULD include unit tests to ensure the change works as
1515 expected and to prevent regressions.
1616 Any pull request containing a bug fix SHOULD include a regression test for the given fix.
1717
18- * ** Document any change in behaviour:** Homebridge projects rely on inline documentation
19- powered by[ TypeDoc] [ typedoc-formatting ] .
18+ - ** Document any change in behaviour:** Homebridge projects rely on inline documentation
19+ powered by[ TypeDoc] [ typedoc-formatting ] .
2020 Additionally, some projects MAY rely on GitHub Wikis which MIGHT need to be updated.
2121
22- * ** Consider our release cycle:** Before creating any pull request, please read through our concept for
22+ - ** Consider our release cycle:** Before creating any pull request, please read through our concept for
2323[ release cycles] [ release-cycle ] . Most notably the section explaining our[ Git Workflow] [ git-workflow ] .
2424
25- * ** One pull request per feature:** If you want to do more than one thing, send multiple pull requests.
25+ - ** One pull request per feature:** If you want to do more than one thing, send multiple pull requests.
2626 Otherwise, your pull request could be rejected.
2727
28- * ** Send coherent history:** Make sure each individual commit in your pull request is meaningful.
28+ - ** Send coherent history:** Make sure each individual commit in your pull request is meaningful.
2929 If you had to make multiple intermediate commits while developing,
3030 please[ rebase or squash them] [ link-git-rewrite ] before submitting.
3131
@@ -50,7 +50,9 @@ See [SECURITY.md](SECURITY.md)
5050[ link-typescript ] :https://www.typescriptlang.org/
5151[ link-eslint ] :https://eslint.org/
5252[ typedoc-formatting ] :https://typedoc.org/guides/doccomments/
53+
5354<!-- TODO update wiki page links, currently they point to the HAP-NodeJS repo!-->
55+
5456[ release-cycle ] :https://github.com/homebridge/HAP-NodeJS/wiki/Release-Cycle
5557[ git-workflow ] :https://github.com/homebridge/HAP-NodeJS/wiki/Release-Cycle#git-workflow
5658[ link-git-rewrite ] :http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages