contributing

_posts/2025-10-20-contributing.md

@@ -0,0 +1,105 @@
+---
+title: "Want to Contribute to OpenVoiceOS? Here’s How We Make It Fun and Easy!"
+excerpt: "We’re so excited that you're thinking about contributing to OpenVoiceOS! This project is a massive, collaborative effort across many smaller repositories, and it all comes together because of awesome people like you."
+coverImage: "/assets/blog/contributing/thumb.png"
+date: "2025-10-11T00:00:00.000Z"
+author:
+  name: JarbasAl
+  picture: "https://avatars.githubusercontent.com/u/33701864"
+ogImage:
+  url: "/assets/blog/contributing/thumb.png"
+---
+
+## Want to Contribute to OpenVoiceOS? Here’s How We Make It Fun and Easy!
+
+We’re so excited that you're thinking about contributing to OpenVoiceOS! This project is a massive, collaborative effort across many smaller repositories, and it all comes together because of awesome people like you.
+
+We know that diving into an open-source project can sometimes feel intimidating. You might worry about making a mistake or not following every little rule. **We want to assure you: don't sweat the small stuff!** Our entire process is designed to be welcoming, collaborative, and, most importantly, helpful.
+
+Ready to jump in? Here’s a personal look at how we handle **Pull Requests (PRs)** and what you can expect when you contribute.
+
+---
+
+## 🚀 The TL;DR on Contributing
+
+If you only have a minute, here are the key takeaways for getting your amazing code into OpenVoiceOS:
+
+* **Open a Draft PR Early:** Don't wait for perfection. We want to see your work in progress!
+* **Our Bot is Your Friend:** The **Code RabbitAI** bot automatically gives feedback to speed things up.
+* **Everyone Can Review:** You don't have to be a maintainer to offer a helpful review on another PR.
+* **Use Clear Commit Messages:** We use **Conventional Commits** (e.g., `feat: add new command`).
+* **Clean History, Simplified:** We squash-merge your PR, so don't obsess over a pristine commit history.
+* **We’ll Help You Get It Right:** Seriously, if anything is confusing, we're here to guide you.
+
+---
+
+## 👋 Meet the Reviewers: It's Not Just the Core Team
+
+OpenVoiceOS is a true volunteer-driven project. While we do have a small core team responsible for the overall architecture and merging PRs, they are absolutely **not** the only people reviewing code.
+
+**Everyone is welcome to review PRs!**
+
+We strongly encourage you to jump into any open PRs and offer your thoughts. Why?
+
+1.  **Any Input is Valuable:** A review comment, an improvement suggestion, or even just a simple "I tested this using X, and it works!" is incredibly helpful.
+2.  **It's a Fantastic Way to Learn:** Reviewing others' code gives you a deeper understanding of how OpenVoiceOS works under the hood.
+
+So, when you open your own PR, consider checking out a few others to pay it forward!
+
+---
+
+## 🛠️ Opening and Managing Your Contribution
+
+We believe in early collaboration, which is why we encourage you to open PRs **early and often**, even if your code is messy or incomplete. Getting eyes on your work sooner means we can offer feedback and guidance throughout your development process.
+
+### Your Co-Pilot: Code RabbitAI
+
+The moment you open a PR, our **Code RabbitAI bot** automatically jumps in to review your code. Think of this bot as your personal assistant for the initial checks. It helps with:
+
+* **Initial Checks & Style Suggestions:** It speeds up the review process by catching low-hanging fruit.
+* **Draft Mode is Your Friend:** If you’re actively coding and don't want the bot to "interrupt" you, simply mark your PR as a **Draft**. When you're ready for feedback, mark it as **Ready for Review**, and the bot will re-engage!
+
+### Commit History? Don’t Worry About It!
+
+When you’re making changes, your PR might rack up a few commits. Don't waste time trying to perfectly structure your local commits!
+
+We **squash-merge all PRs** when they are ready to go into the main `dev` branch. This means all of your individual commits are condensed into a single, clean commit. This keeps our main branch history easy to navigate, and your single merged commit will still link directly back to your original PR for reference.
+
+### Code Style: Keep it Simple
+
+While we loosely follow **PEP8** (the Python standard), we don't want strict style adherence to be a barrier to entry. Just use common sense and try to stick to the style of the surrounding code. We rely on our bots and Continuous Integration (CI) tools to handle most of the nitpicky style stuff, leaving you free to focus on the awesome features you're building!
+
+---
+
+## 💡 What Happens After You Open a PR?
+
+1.  **Initial Bot Review:** Code RabbitAI gives you the first round of feedback.
+2.  **Maintainer Review:** Our core team steps in for a more in-depth review on functionality and design.
+3.  **Iteration:** You'll likely go through a few rounds of revisions based on the feedback. Use the **Draft** feature liberally to manage this process.
+4.  **Merging!** Once everything looks great and all checks pass, a maintainer will merge your work into the `dev` branch.
+
+### What if my PR isn't merged?
+
+This happens sometimes, often due to changes in overall architecture or project direction. **Please don't take it personally!** We promise we’ll most likely offer an alternative, such as turning your work into a standalone plugin that you can maintain independently. Just chat with us about it!
+
+---
+
+## ✅ We’re Thrilled to Have You!
+
+Seriously, if any of the above sounds complicated, don't worry about it for a second. Our bots and our team are here to guide you. If your commit message needs tweaking or your code needs a slight refinement, we'll either fix it for you or walk you through the change.
+
+We look forward to seeing what you build and to collaborating with you on the next great features for OpenVoiceOS! **What are you excited to work on first?**
+
+---
+
+## Help Us Build Voice for Everyone
+
+OpenVoiceOS is more than software, it’s a mission. If you believe voice assistants should be open, inclusive, and user-controlled, here’s how you can help:
+
+- **💸 Donate**: Help us fund development, infrastructure, and legal protection.
+- **📣 Contribute Open Data**: Share voice samples and transcriptions under open licenses.
+- **🌍 Translate**: Help make OVOS accessible in every language.
+
+We're not building this for profit. We're building it for people. With your support, we can keep voice tech transparent, private, and community-owned.
+
+👉 [Support the project here](https://www.openvoiceos.org/contribution)