Reporting Issues and Feature Requests

We value your feedback! If you encounter issues or have suggestions for new features, there are multiple ways to report them.

Discord

Join our Discord server to engage with the community, share your thoughts, and get help; here.

GitHub Issues

Submitting issues on GitHub allows for structured tracking and collaboration. Follow the steps below:

1. Navigate to the Relevant Repository:

   • For Windows app features/issues
   • For Documentation features/issues
   • For Integration issues

2. Access the "Issues" Tab:

   • Click on the "Issues" tab at the top of the repository.

3. Select the Appropriate Template:

   • Create a new issue by clicking the "New Issue" button.
   • Choose the relevant template for bug reports or feature requests.

4. Provide Detailed Information:

   • Fill out the issue template with as much detail as possible.
   • Include permalinks by clicking the "P" icon to the right of any title in the documentation, it will append a # and the title slug to the URL in your browser. You can now copy the link and place it in your github issue.

5. Submit Your Issue:

   • Once filled, click on "Submit new issue."

Tips for Effective Reporting

• Be Descriptive: Clearly describe the issue or feature request.
• Reproducible Steps: If applicable, provide step-by-step instructions to reproduce the issue.
• Attach Screenshots: Include screenshots to help illustrate the problem.
• Use Permalinks: Utilize permalinks by clicking the "P" icon to the right of any title before copying the URL.

Issue Templates

To streamline the reporting process, we have specific templates for bug reports and feature requests. Choose the relevant template when creating a new issue. Each Repo contains different templates but the main ones are listed here:

• Bug Reports: For any problems or bugs you encounter while using HASS.Agent.
• Feature Requests: For any features or suggestions you have to improve HASS.Agent.

Thank you for contributing to the improvement of Hass.agent!

Permalinks

Permalinks are permanent links that point to a specific section in the documentation. A permalink can point to any heading found in the documentation. If you are asked to provide a link to the place where you are having issues or want something new make sure to use a permalink. You can get a permalink by following these steps:

1. Find the heading directly above the section your are linking to.
2. Click the "P" icon to the right of the heading.
3. Copy the address from the top of your browser.

Tip

For a faster way to get a permalink you can right click the "P" icon and select "Copy Link Address".