Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 1.23 KB

File metadata and controls

75 lines (48 loc) · 1.23 KB

📄 2. CONTRIBUTING.md (Template)

# Contributing to Ella Box

Thank you for your interest in contributing! 🙌

We welcome all kinds of contributions: documentation, bug fixes, features, artwork, examples, and more.

---

## 🔹 Before You Begin

1. Fork this repository
2. Create a new branch:
3. Make changes
4. Submit a Pull Request (PR)

---

## 💡 Ways to Contribute

### 🛠 Bug Fixes
- Reproduce the bug
- Add a test (if applicable)
- Fix and describe the change in the PR

### Features
- Describe the feature in an issue first
- Make sure it follows project goals

### Documentation
- Add missing wiring diagrams
- Improve installation steps
- Example projects

### Examples
Share real use cases — e.g.
- Home display data
- Smart home controller
- Custom menus

---

## Guidelines

- Write clear commit messages
- Keep changes small and focused
- Follow existing code style
- Comment where helpful

---

## Testing

Before submitting:

- Verify it compiles
- Test on real hardware
- Update README/examples accordingly

---

## Community

Join discussions by opening issues — we reply and collaborate!

---

## ❤️ Thanks!

Thanks for being part of this project! Contribution makes open-source stronger 💪