alex/homeassistant-mcp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
v0.0.7
homeassistant-mcp/docs/contributing.md
jango-blockchained 3a54766b61 docs: refactor and improve documentation across multiple files 
- Streamline and enhance documentation for API, architecture, getting started, and usage
- Improve clarity, readability, and organization of documentation files
- Update content to be more concise and informative
- Ensure consistent formatting and style across documentation
2025-02-04 17:33:26 +01:00

1.3 KiB
Raw Permalink Blame History

Contributing to Home Assistant MCP

We welcome community contributions to improve the MCP Server. Please review the following guidelines before contributing.

How to Contribute

  1. Fork the Repository: Create your personal fork on GitHub.
  2. Create a Feature Branch: Use a clear name (e.g., feature/your-feature or bugfix/short-description).
  3. Make Changes: Develop your feature or fix bugs while following our coding standards.
  4. Write Tests: Include tests for new features or bug fixes.
  5. Submit a Pull Request: Once your changes are complete, submit a PR for review.
  6. Address Feedback: Revise your PR based on maintainers' suggestions.

Code Style Guidelines

  • Follow the project's established coding style.
  • Use Bun tooling for linting and formatting:
    • bun run lint
    • bun run format

Documentation

  • Update documentation alongside your code changes.
  • Ensure tests pass and coverage remains high.

Reporting Issues

  • Use the GitHub Issues page to report bugs, request new features, or ask questions.
  • Provide clear descriptions, replication steps, and any error logs.

Community

  • Join our real-time discussions on our chat platforms (Discord, Slack, etc.).
  • Engage with other contributors to exchange ideas and solutions.

Thank you for helping improve the Home Assistant MCP project!