mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-28 08:49:42 +02:00
feat: add README, LICENSE, CONTRIBUTING
This commit is contained in:
parent
d28991fc60
commit
957cdcf363
4 changed files with 247 additions and 1 deletions
64
CONTRIBUTING.md
Normal file
64
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
# Contributing to Dograh AI
|
||||
|
||||
First off — thank you for considering contributing! 🎉
|
||||
Dograh AI is open source because we believe the future of voice AI should stay in the hands of developers and the community.
|
||||
|
||||
For now, this guide will get you started. Future documentation will be more comprehensive and is under progress.
|
||||
👉 Join us → [Dograh Community Slack](https://join.slack.com/t/dograh-community/shared_invite/zt-3czr47sw5-MSg1J0kJ7IMPOCHF~03auQ)
|
||||
|
||||
|
||||
|
||||
## 🙌 How You Can Contribute
|
||||
|
||||
- 🐛 **Report bugs** via GitHub Issues
|
||||
- 💡 **Suggest features**
|
||||
- 🔧 **Submit pull requests**
|
||||
- 📖 **Improve documentation** — even fixing typos helps!
|
||||
- 💬 **Join the Slack community** — the cornerstone of our collaboration
|
||||
|
||||
|
||||
|
||||
## 🧰 Issue Types
|
||||
|
||||
On our [GitHub Issues page](../../issues), you’ll find these categories:
|
||||
|
||||
- 📄 **Documentation change request**
|
||||
- ✨ **Feature request**
|
||||
- 🐞 **Bug report**
|
||||
- ❓ **General questions**
|
||||
- 🔒 **Security vulnerability report**
|
||||
|
||||
👉 A great place to start is with issues tagged **`good first issue`**.
|
||||
|
||||
|
||||
|
||||
## 🛠 Development Guidelines
|
||||
|
||||
- Keep PRs focused and scoped.
|
||||
- Follow Python best practices (PEP8).
|
||||
- Please **link the issue** in your PR description using: fixes #<issue_number>
|
||||
|
||||
This auto-closes the issue when merged.
|
||||
|
||||
|
||||
|
||||
## 🚀 Getting Started
|
||||
- Fork the repository
|
||||
- Create your feature branch (git checkout -b feature/AmazingFeature)
|
||||
- Commit your changes (git commit -m 'Add some AmazingFeature')
|
||||
- Push to the branch (git push origin feature/AmazingFeature)
|
||||
Open a Pull Request 🎉
|
||||
|
||||
|
||||
|
||||
## 💬 Community & Contribution Hub
|
||||
Our Slack community is not just for support — it’s the cornerstone of Dograh AI contributions. Here, you can:
|
||||
- Connect with maintainers and other contributors
|
||||
- Discuss issues and features before coding
|
||||
- Get help with setup and debugging
|
||||
- Stay up to date with contribution sprints
|
||||
|
||||
|
||||
👉 Join us → [Dograh Community Slack](https://join.slack.com/t/dograh-community/shared_invite/zt-3czr47sw5-MSg1J0kJ7IMPOCHF~03auQ)
|
||||
|
||||
Thank you for helping us keep Dograh AI open and thriving! 💜
|
||||
Loading…
Add table
Add a link
Reference in a new issue