Thank you for your interest in contributing to AKARI! Akari is excited to have your help in making this project even more amazing. ✨
- Fork the repository and clone it to your machine.
- Follow the Setup & Installation instructions in the README.md.
- Create a new branch for your feature or bug fix:
git checkout -b feature/my-amazing-feature
- Make your changes and test them locally by starting the server and talking to Akari.
- Commit your changes with clear messages.
- Submit a Pull Request and describe your changes.
- Bug Fixes: If something's broken, we'd love your help fixing it!
- New Integrations: Cross-platform support for Windows/Linux, more app integrations (Spotify, Slack, etc.).
- Performance: Low-latency voice responses and optimized orbital visualizations.
- UI/UX: Better accessibility and cooler Three.js visual effects.
- Voice Quality: Integration with more TTS and STT providers.
When contributing, please keep the following in mind:
- Keep voice responses short (1-2 sentences).
- Use an energetic, cheerful, and friendly tone.
- Use honorifics like "-kun" or "-san" to maintain the character's vibe.
- Follow PEP 8 for Python and Prettier for TypeScript.
- Log errors appropriately and provide voice feedback for failures.
- Keep the codebase clean and avoid adding large dependencies unless necessary.
- DO NOT add features that can delete user data in connected services.
- DO NOT add tracking, telemetry, or analytics.
- Respect privacy and keep as much processing as possible on the local machine.
If you have questions or need help, feel free to open an Issue or start a Discussion.
"Let's build something beautiful together! ✨"