Include default repositories

Who can submit?¶

Only the owner or a major contributor of a repository can submit a pull request (PR) to add it as a default.
Custom integrations used for alpha or beta testing core integrations, or those that override core integrations, are not accepted as defaults. You can still use them as a custom repository.

Before you start¶

Make sure your repository meets these requirements:

Your repository can be added to HACS as a custom repository.
Your repository is public and hosted on GitHub.
Add and pass these GitHub Actions:
- HACS Action (Before you submit your PR, this action must pass without any errors or ignores.)
- Hassfest (for integrations only)
Create a new GitHub release (not just a tag, a full release) after the actions run successfully.

Once everything checks out, add your repository to the appropriate file in hacs/default.

./appdaemon for AppDaemon apps
./integration for integrations (custom components)
./plugin for plugins (custom cards, dashboards, etc.)
./python_script for Python scripts (made for the Python script integration)
./template for templates (for custom templates)
./theme for themes

Additional information¶

Make sure to add your entry in the list alphabetically, and not at the end.
Your PR must be editable, so don’t submit it from an organization account.
In your fork of hacs/default, always create a new branch from master for your changes. Don’t use the master branch directly.
If your repository is for a single or a limited set of countries, the country key needs to be set in the released hacs.json file.
If you did not fill out the pull request template correctly, your PR will be closed without further notice.
If you misrepresent your statements in the pull request, your PR will be closed without further notice.
If you are not the owner of the repository, or a major contributor, your PR will be closed without further notice.
If the repository does not meet the requirements for inclusion, your PR will be drafted for minor issues, and closed for major issues.
If your PR is drafted, set it to ready for review when you are ready for it to be reviewed.

What happens next?¶

HACS is growing fast, with new repositories added almost daily, but new additions still take months to be reviewed and included. Want to check the status of your PR? Visit the backlog to see where things stand.

If you have questions or run into issues, check the documentation or reach out to the community. Good luck, and thank you for contributing!

When your repository is up for review, a set of automated checks are run. All checks must pass unless otherwise agreed upon with the HACS team before the PR was opened. Here’s what’s checked:

Check brands¶

Checks that your repository is added to home-assistant/brands. Applies only to integrations.

Check manifest¶

Checks that your integration's manifest is valid. Learn more or see the integration manifest documentation. Applies only to integrations.

Check hacs-validation¶

Runs the same validation that HACS itself uses to check your repository.

Check HACS manifest¶

Checks that your hacs.json file contains at least a name. See requirements

Check archived¶

Checks if your repository is archived. It must be active.

Check releases¶

Checks that your repository has at least one release.

Check owner¶

Checks if the submitter is the owner or a major contributor to the repository.

Check images¶

Applies only to plugins and themes.

Checks that images are present in the readme file for HACS to render.

Check repository¶

Checks general repository requirements: - The repository has a description - The repository has issues enabled - The repository has topics defined

lint jq¶

Ensures that the files in your PR are valid JSON.

lint sorted¶

Ensures that the files in your PR are sorted correctly.

After the PR is merged¶

After your PR is merged, your repository will be included in the next scheduled scan.