diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..9486387 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,46 @@ +--- +name: Bug Report +about: Report a bug or unexpected behavior +title: '' +labels: bug +assignees: '' +--- + +## Describe the Bug + +A clear description of what the bug is. + +## Environment + +- **Home Assistant version:** +- **Integration version:** +- **Immich version:** + +## Steps to Reproduce + +1. +2. +3. + +## Expected Behavior + +What you expected to happen. + +## Actual Behavior + +What actually happened. + +## Logs + +
+Relevant log entries + +``` +Paste logs here +``` + +
+ +## Additional Context + +Any other context about the problem. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..6de52d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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: Immich Documentation + url: https://immich.app/docs + about: Immich official documentation diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..b0cbb31 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,27 @@ +--- +name: Feature Request +about: Suggest a new feature or enhancement +title: '' +labels: enhancement +assignees: '' +--- + +## Feature Description + +A clear description of what you would like to see added. + +## Use Case + +Describe the problem this feature would solve or the use case it enables. + +## Proposed Solution + +If you have ideas on how to implement this, describe them here. + +## Alternatives Considered + +Any alternative solutions or features you've considered. + +## Additional Context + +Any other context, screenshots, or examples. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..3dc4efa --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,20 @@ +## Description + +Brief description of the changes. + +## Type of Change + +- [ ] Bug fix +- [ ] New feature +- [ ] Documentation update +- [ ] Other (describe): + +## Testing + +Describe how you tested these changes. + +## Checklist + +- [ ] Code follows project style guidelines +- [ ] Changes have been tested locally +- [ ] Documentation updated (if applicable) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0e2eb1a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +# Contributing to Immich Album Watcher + +Thank you for your interest in contributing to this Home Assistant integration! + +## Getting Started + +1. Fork the repository +2. Clone your fork locally +3. Create a new branch for your changes + +## Development Setup + +1. Set up a Home Assistant development environment +2. Copy the `custom_components/immich_album_watcher` folder to your HA config +3. Restart Home Assistant to load changes + +## Code Style + +- Follow [Home Assistant's development guidelines](https://developers.home-assistant.io/docs/development_guidelines) +- Use type hints for all function parameters and return values +- Keep code compatible with Python 3.11+ + +## Submitting Changes + +1. Test your changes thoroughly +2. Update documentation if needed +3. Create a pull request with a clear description of changes + +## Reporting Issues + +When reporting bugs, please include: + +- Home Assistant version +- Integration version +- Immich server version +- Relevant log entries +- Steps to reproduce + +## Version Numbering + +This project uses semantic versioning: + +- **MAJOR** (x.0.0): Breaking changes +- **MINOR** (0.x.0): New features, backward compatible +- **PATCH** (0.0.x): Bug fixes + +## Questions? + +Open an issue for any questions about contributing.