alexei.dolgolyov
4d4fa887af
- CONTRIBUTING.md with blueprint submission guidelines - Issue templates for bugs and feature requests - Pull request template Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
46 lines
1.1 KiB
Markdown
46 lines
1.1 KiB
Markdown
# Contributing to Home Assistant Blueprints
|
|
|
|
Thank you for your interest in contributing to this collection of Home Assistant blueprints!
|
|
|
|
## Getting Started
|
|
|
|
1. Fork the repository
|
|
2. Clone your fork locally
|
|
3. Create a new branch for your changes
|
|
|
|
## Adding a New Blueprint
|
|
|
|
1. Place your blueprint in the appropriate folder:
|
|
- `Common/` - General purpose blueprints
|
|
- `Zigbee/` - MQTT/Zigbee device blueprints
|
|
2. Follow the existing naming conventions
|
|
3. Include proper metadata in your blueprint (name, description, domain)
|
|
4. Update `README.md` to list your new blueprint
|
|
|
|
## Blueprint Guidelines
|
|
|
|
- Use clear, descriptive names for inputs
|
|
- Provide helpful descriptions and default values
|
|
- Include input validation where appropriate
|
|
- Test thoroughly before submitting
|
|
|
|
## Submitting Changes
|
|
|
|
1. Test your blueprint in Home Assistant
|
|
2. Update documentation if needed
|
|
3. Create a pull request with a clear description
|
|
|
|
## Reporting Issues
|
|
|
|
When reporting bugs, please include:
|
|
|
|
- Home Assistant version
|
|
- Blueprint name
|
|
- Steps to reproduce
|
|
- Expected vs actual behavior
|
|
- Relevant log entries
|
|
|
|
## Questions?
|
|
|
|
Open an issue for any questions about contributing.
|