.github/CONTRIBUTING.md at main · homeassistant-ai/.github · GitHub
Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 2.5 KB

Contributing to Home Assistant AI Projects

Thank you for your interest in contributing! This organization maintains several projects focused on AI-powered Home Assistant automation.

🚀 Getting Started

  1. Choose a project from our organization page
  2. Check the project's CONTRIBUTING.md for specific setup and testing instructions
  3. Fork and clone the repository
  4. Make your changes following the project's guidelines
  5. Open a Pull Request using the project's PR template

📋 General Guidelines

Code Quality

  • Follow existing code patterns and style in each project
  • Add tests for new features or bug fixes
  • Ensure all automated tests pass before submitting PRs
  • Run linters and type checkers as specified in project docs

Communication

  • Use issue templates when reporting bugs or requesting features
  • Be clear and concise in issue descriptions and PR explanations
  • Respond to feedback on PRs in a timely manner
  • Be respectful and constructive in all interactions

Pull Requests

  • Keep PRs focused on a single issue or feature
  • Write clear commit messages
  • Update documentation for user-facing changes
  • Link to related issues using Fixes #123 or Closes #123

🐛 Reporting Issues

Each project has specific issue templates:

  • Bug reports: Use the bug report template and include reproduction steps
  • Feature requests: Describe the use case and desired behavior
  • Questions: Check existing issues/discussions first

Note: Some projects have AI-assisted reporting tools (e.g., ha_report_issue in ha-mcp). Use these when available for better diagnostics.

🔒 Security

Found a security vulnerability? Please follow our Security Policy and do not open a public issue.

📖 Project-Specific Guides

  • ha-mcp: MCP server development, testing, and tool creation
  • skills: Skill authoring, testing, and quality standards

🎯 First-Time Contributors

Look for issues labeled good first issue in any of our repositories. These are designed to be approachable for newcomers.

💬 Need Help?

  • Check the project's README and documentation first
  • Search existing issues and discussions
  • Open a new discussion or issue if you can't find answers
  • Be patient—maintainers are volunteers

Thank you for contributing to Home Assistant AI! 🎉