alex/homeassistant-mcp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
v0.4.12
homeassistant-mcp/docs/contributing.md
jango-blockchained 3e7f3920b2 docs: update project documentation with simplified, focused content 
- Streamline README, API, architecture, and usage documentation
- Reduce complexity and focus on core functionality
- Update roadmap with more pragmatic, near-term goals
- Simplify contributing guidelines
- Improve overall documentation clarity and readability
2025-02-05 10:40:27 +01:00

1.9 KiB
Raw Permalink Blame History

layout, title, nav_order
layout title nav_order
default Contributing 5

Contributing Guide 🤝

Thank you for your interest in contributing to the MCP Server project!

Getting Started

Prerequisites

  • Bun >= 1.0.26
  • Home Assistant instance
  • Basic understanding of TypeScript

Development Setup

  1. Fork the repository

  2. Clone your fork:

    git clone https://github.com/YOUR_USERNAME/homeassistant-mcp.git
cd homeassistant-mcp

  3. Install dependencies:

    bun install

  4. Configure environment:

    cp .env.example .env
# Edit .env with your Home Assistant details

Development Workflow

Branch Naming

  • feature/ - New features
  • fix/ - Bug fixes
  • docs/ - Documentation updates

Example:

git checkout -b feature/device-control-improvements

Commit Messages

Follow simple, clear commit messages:

type: brief description

[optional detailed explanation]

Types:

  • feat: - New feature
  • fix: - Bug fix
  • docs: - Documentation
  • chore: - Maintenance

Code Style

  • Use TypeScript
  • Follow existing code structure
  • Keep changes focused and minimal

Testing

Run tests before submitting:

# Run all tests
bun test

# Run specific test
bun test test/api/control.test.ts

Pull Request Process

  1. Ensure tests pass
  2. Update documentation if needed
  3. Provide clear description of changes

PR Template

## Description
Brief explanation of the changes

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update

## Testing
Describe how you tested these changes

Reporting Issues

  • Use GitHub Issues
  • Provide clear, reproducible steps
  • Include environment details

Code of Conduct

  • Be respectful
  • Focus on constructive feedback
  • Help maintain a positive environment

Resources

Thank you for contributing!