First off, thank you for considering contributing to Open Velocity! 🎉 It's people like you that make this such a great tool for the community.
If you've noticed a 🐛 bug or have a 💡 feature request:
- Search the issue tracker to see if it's already been reported.
- If not, feel free to create a new issue!
If you want to contribute code:
- Fork the repository.
- Create a new branch for your work (
git checkout -b feature/amazing-feature). - Commit your changes following our commit style.
- Submit a Pull Request! 🚀
Please follow the coding style of the project. We aim for clean, readable code.
- We use TypeScript for the core logic.
- We follow standard linting rules (see
package.jsonfor details).
We use Conventional Commits for our commit messages. This helps us generate changelogs and manage releases automatically. ✨
Example: feat: add new gemini provider or fix: resolve race condition in agent manager.
When you're ready to submit:
- ✅ Run the tests to ensure everything is working as expected.
- 📚 Update the documentation if you've made any changes to the API or features.
- 🎨 Format your code correctly.
- Write a clear description of your changes in the PR.
Join our Discord server to chat with the team, ask questions, and share your ideas! 💬
Thank you for your contribution! You are awesome! ❤️