Welcome! We're thrilled you're considering contributing to Zentry. This assistant is open-source and community-driven β every issue you raise, line of code you write, or idea you share makes this project better.
Before contributing, please read these quick rules:
- Be respectful and inclusive β we value all perspectives.
- Keep your PRs focused and scoped to one problem/feature.
- Use clear commit messages (
feat:,fix:,docs:format preferred). - Follow the existing code style (Pythonic, clean, async-safe).
- Open an issue before submitting large features.
git clone https://github.com/Zentry-org/.github.git
cd zentry-ai-assistantgit checkout -b feature/my-cool-feature- Add code or documentation.
- Run tests (if applicable).
- Ensure no broken imports or runtime errors.
git add .
git commit -m "feat: add speech tuning support"
git push origin feature/my-cool-feature- Target the
mainbranch unless told otherwise. - Add a clear PR description.
- Link related issues (e.g.
Fixes #12). - Add screenshots if itβs a UI change.
| Area | Description |
|---|---|
| π£οΈ Speech Accuracy | Improve STT transcription (Malayalam, noisy audio) |
| π§ NLP / LLM | Custom prompts, reasoning logic, or memory support |
| π VoIP Layer | SIP handling, call state feedback, call logs |
| π TTS Output | Integrate new TTS libraries (Tortoise, Coqui) |
| π Dashboard UI | Build a React-based call visualizer |
| π Docs | Better setup guides, architecture, or tutorials |
| π Bug Fixes | Crash handling, edge cases, error logging |
- Python: Follow PEP8
- Use async/await for real-time tasks
- Avoid hardcoded paths, use
Pathlib - Avoid pushing
.env, API keys, model files
- Look for issues labeled
good first issue - Feel free to ask questions in Discussions
- Your idea doesn't have to be perfect β start small!
All contributors must adhere to our Code of Conduct. We foster a safe, welcoming space.
Create a new Discussion topic or open an issue. One of the maintainers will get back to you soon.
Happy hacking! π β Team Zentry