alexei.dolgolyov
d26e212c82
All checks were successful
Validate / Hassfest (push) Successful in 3s
- CONTRIBUTING.md with development guidelines - Issue templates for bugs and feature requests - Pull request template Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
50 lines
1.2 KiB
Markdown
50 lines
1.2 KiB
Markdown
# 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.
|