Skip to content

🤝 Contributing to Mushroom Strategy#

We love contributions from the community! Whether you're reporting a bug, suggesting a new feature, or submitting code changes, your help makes the Mushroom Strategy better for everyone.

Please take a moment to review this guide before making a contribution.

📜 Code of Conduct#

To ensure a welcoming and inclusive environment, all contributors are expected to adhere to our Code of Conduct. Please read it carefully.

🐞 Reporting Bugs#

Found a bug? That's not ideal, but your report helps us squash it!

  1. Check existing issues: Before opening a new issue, please search our GitHub Issues or Discussions to see if the bug has already been reported.
  2. Open a new issue: If it's a new bug, please open a new issue.

  3. Provide details: In your report, please follow the instructions and template to include:

  4. A clear and concise description of the bug.

  5. Steps to reproduce the behavior.
  6. Expected behavior.
  7. Screenshots or animated GIFs (if applicable).
  8. Your Home Assistant version and Mushroom Strategy version.

✨ Suggesting Features#

Have a great idea for a new feature or enhancement? We'd love to hear it!

  1. Check existing suggestions: Search our GitHub Issues or Discussions to see if the feature has already been requested.
  2. Open a new issue: If it's a new idea, open a new issue.
  3. Describe your idea: Clearly explain the feature, why you think it's useful, and any potential use cases by following the instructions and template.

🙏 Get Support#

If you have questions about contributing or need help with your setup, please open a discussion on our GitHub repository.