Files
homarr/.github/pull_request_template.md

1.2 KiB


Homarr

Thank you for your contribution. Please ensure that your pull request meets the following requirements:

  • Relevant checks pass without warnings or errors
  • Pull request targets the intended base branch (dev by default; release/v2 for v2 release work)
  • Commits follow the conventional commits guideline
  • No shorthand variable names are used (for example, x, y, i, or abbreviations)
  • User-facing changes include matching documentation updates under apps/docs
  • When using AI, no temporary files are checked in and the code style follows the rest of the project

When contributing a new integration or widget:

  • I confirmed manually that the integration or widget is working with a real system and performed basic smoke tests (e.g. what happens if it is offline)
  • Optional but recommended: I confirm that I am willing to be added to the CODEOWNERS of this feature and will provide support and maintain the integration (e.g. in case of breaking or failure)