From a81afbf2805cd6c8d00fd0c6f3e4af2739fd8556 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B8rgen=20Ferdinand?= <32671211+Ferdinand99@users.noreply.github.com> Date: Wed, 21 May 2025 16:51:20 +0200 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2972048 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,88 @@ +# πŸ§‘β€πŸ’» Contributing to the Home Assistant Newt Add-on + +Thanks for your interest in contributing to the **Newt Add-on** for Home Assistant! +We welcome all kinds of contributions β€” from code, testing, documentation, translations, and feedback. + +--- + +## πŸ“Œ Quick Links + +- πŸ“¦ Add-on Repository: https://github.com/Ferdinand99/home-assistant-newt-addon +- πŸ“š Documentation: https://docs.fossorial.io/Newt/overview +- πŸ’¬ Community: Join us on Discord β†’ [[Invite Link]](https://discord.gg/fTHY3ZM8nY) + +--- + +## 🧭 Ways to Contribute + +| Type | How to Help | +|---------------------------|---------------------------------------------------------------| +| πŸ› Report Bugs | Use the `#πŸ›γƒ»bug-reports` channel on Discord or open an issue | +| πŸ”§ Suggest Features | Use `#πŸ”§γƒ»feature-requests` or GitHub Issues | +| πŸ‘₯ Code Contributions | PRs are welcome! See coding guidelines below | +| πŸ“– Improve Documentation | Fix typos, clarify steps, or update setup info | +| 🌍 Translate | Add or improve localization (coming soon) | +| 🧠 Community Support | Help answer questions in `#❓・questions` or `#setup-help` | + +--- + +## πŸ”§ Getting Started (For Developers) + +1. **Fork the repo** and clone it to your machine +2. Check out [Home Assistant Developer Tools](https://developers.home-assistant.io/docs/add-ons/) +3. Test your changes using the Home Assistant Add-on system + +--- + +## πŸ›  Folder Structure + +/home-assistant-newt-addon/ +β”œβ”€β”€ config.json # Add-on manifest +β”œβ”€β”€ Dockerfile # Add-on runtime environment +β”œβ”€β”€ run.sh # Entrypoint script +β”œβ”€β”€ README.md # Project overview +└── ... # Other internal files + + +--- + +## βœ… Code Style & Rules + +- Follow **PEP8** (Python) or **Bash best practices** where applicable +- Use **descriptive commit messages** +- Keep PRs focused: one feature/fix per PR +- Test your changes in Home Assistant if possible +- Use code blocks and logs for debugging in Discord discussions + +--- + +## πŸ§ͺ Testing + +If you're submitting a fix or feature: +- Provide clear **reproduction steps** or **test cases** +- Add logs or screenshots if helpful +- Indicate what platform/setup you tested on (HAOS, Docker, etc.) + +--- + +## πŸ“₯ Pull Request Guidelines + +- Branch from `main` +- Include a clear title and description +- Reference related issues or discussions +- Mark PRs as `Draft` if still in progress +- Use threads in Discord `#πŸ‘₯・code-contributions` for coordination + +--- + +## πŸ’¬ Need Help? + +Join the Discord and post in: + +- `#❓・questions` β€” for general confusion +- `#πŸ‘₯・code-contributions` β€” for development collab +- `#πŸ“šγƒ»documentation` β€” if you're improving the docs + +--- + +Let’s build something awesome together! πŸš€