Files

jango-blockchained b0ad1cf0ad docs: add comprehensive documentation for MCP project

- Create comprehensive documentation structure using MkDocs
- Add markdown files for API reference, architecture, getting started, and troubleshooting
- Configure GitHub Pages deployment workflow
- Include custom Jekyll and MkDocs configurations
- Add custom styling and layout for documentation site

2025-02-04 17:14:39 +01:00

1.5 KiB

Raw Blame History

Contributing to Home Assistant MCP

We welcome contributions from the community! Your help and feedback are essential to improving the MCP Server. Please review the following guidelines before contributing.

How to Contribute

Fork the Repository: Create your personal fork of the project on GitHub.
Create a Feature Branch: Use clear branch names, e.g., feature/your-feature or bugfix/short-description.
Make Changes: Develop your feature or fix bugs. Ensure your code follows the project's coding conventions.
Write Tests: Include tests for new features or bug fixes. We aim for high code coverage.
Submit a Pull Request (PR): Once your changes are complete, submit a PR. Our team will review your request and provide feedback.
Address Feedback: Make any necessary revisions based on code review feedback.

Code Style Guidelines

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

Documentation

Update relevant documentation alongside your code changes.
Ensure that 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!

1.5 KiB Raw Blame History