Add GitHub community files
- 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>
This commit is contained in:
60
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
60
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Report a bug with a blueprint
|
||||
title: ''
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Blueprint Name
|
||||
|
||||
Which blueprint is affected?
|
||||
|
||||
## Describe the Bug
|
||||
|
||||
A clear description of what the bug is.
|
||||
|
||||
## Environment
|
||||
|
||||
- **Home Assistant version:**
|
||||
- **Blueprint version/date downloaded:**
|
||||
|
||||
## Steps to Reproduce
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## Expected Behavior
|
||||
|
||||
What you expected to happen.
|
||||
|
||||
## Actual Behavior
|
||||
|
||||
What actually happened.
|
||||
|
||||
## Blueprint Configuration
|
||||
|
||||
<details>
|
||||
<summary>Your blueprint inputs (remove sensitive data)</summary>
|
||||
|
||||
```yaml
|
||||
Paste configuration here
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## Logs
|
||||
|
||||
<details>
|
||||
<summary>Relevant log entries</summary>
|
||||
|
||||
```
|
||||
Paste logs here
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## Additional Context
|
||||
|
||||
Any other context about the problem.
|
||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Home Assistant Community
|
||||
url: https://community.home-assistant.io/
|
||||
about: Ask questions about Home Assistant
|
||||
- name: Home Assistant Blueprint Documentation
|
||||
url: https://www.home-assistant.io/docs/automation/using_blueprints/
|
||||
about: Learn about using blueprints
|
||||
32
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
32
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Suggest a new blueprint or enhancement
|
||||
title: ''
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Request Type
|
||||
|
||||
- [ ] New blueprint idea
|
||||
- [ ] Enhancement to existing blueprint
|
||||
|
||||
## Blueprint Name (if enhancement)
|
||||
|
||||
Which blueprint should be enhanced?
|
||||
|
||||
## Description
|
||||
|
||||
A clear description of what you would like.
|
||||
|
||||
## Use Case
|
||||
|
||||
Describe the problem this would solve or the automation scenario.
|
||||
|
||||
## Proposed Solution
|
||||
|
||||
If you have ideas on how to implement this, describe them here.
|
||||
|
||||
## Additional Context
|
||||
|
||||
Any other context, examples, or screenshots.
|
||||
24
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
24
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
## Description
|
||||
|
||||
Brief description of the changes.
|
||||
|
||||
## Type of Change
|
||||
|
||||
- [ ] New blueprint
|
||||
- [ ] Bug fix
|
||||
- [ ] Enhancement to existing blueprint
|
||||
- [ ] Documentation update
|
||||
|
||||
## Blueprint(s) Affected
|
||||
|
||||
List the blueprints added or modified.
|
||||
|
||||
## Testing
|
||||
|
||||
Describe how you tested these changes in Home Assistant.
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Blueprint tested in Home Assistant
|
||||
- [ ] README.md updated (if adding new blueprint)
|
||||
- [ ] Blueprint includes proper metadata (name, description, domain)
|
||||
45
CONTRIBUTING.md
Normal file
45
CONTRIBUTING.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# 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.
|
||||
Reference in New Issue
Block a user