Contribution Guideline

The following document describes how to contribute to the STRØM 1.0 project.

Contributing to Stroem 🔊 (Open Source Speaker)

We’re glad you’re considering contributing to Stroem! 🎉 Whether you’re a first-time contributor or a seasoned open source veteran, we’re here to help make your contribution experience as smooth and enjoyable as possible. 💻

Please note that this is an open source speaker project, so some contributions may require specialized knowledge or equipment. 🔧 We appreciate any and all contributions, big or small, and are here to help you get started. 💡

Getting Started 🚀

  1. Before you start, make sure you have a GitHub account. If you don’t have one, sign up for free here. 💻

  2. Take a look at the existing issues to see if there’s anything you’d like to work on. If you have an idea for a new feature or improvement, feel free to open a new issue to start a discussion. 💡

  3. If you’re ready to start coding or working on hardware, fork the repository and clone it to your local machine. 💾

  4. Make your changes and test them thoroughly. 🔧

  5. When you’re ready to submit your changes, create a pull request. Make sure to include a clear and concise description of what you’ve done and why. 📝

Code of Conduct 🤝

At Stroem, we believe in creating a welcoming and inclusive environment for all contributors. 🙏 We follow the Contributor Covenant Code of Conduct, which outlines our expectations for behavior and the consequences for unacceptable behavior.

Help and Support 💬

If you need help or have any questions, feel free to reach out to us by opening an issue or joining our community chat. 💬 We’re here to help and will do our best to support you in your contribution journey. 💪

Thanks for considering contributing to Stroem! We can’t wait to hear what you’ll add to this amazing open source speaker project! 🔊