First of all, thank you for considering contributing to River-Kt! We understand that time is precious, and we deeply appreciate the time you've chosen to spend with us.
Here's how you can help:
If you find our project helpful, interesting, or simply like what we're doing, consider giving us a "Star" on GitHub. This small act boosts our visibility and encourages more potential contributors to join us in improving our codebase.
We take bugs very seriously. If you stumble upon one, we urge you to report it by opening an issue. When doing so, please provide as much information as possible. The issue template will guide you through the process, but remember, the more details, the better.
Have an idea that could improve River-Kt? Don't hesitate to share it with us! We welcome all ideas and suggestions from our community. When you create an issue, please describe your proposal in detail to ensure we fully grasp your concept.
Want to code with us? Whether your intention is to rectify a bug, introduce a new feature, or simply improve our documentation, here's how to proceed:
- Fork the project
- Implement your changes
- Add tests that cover your changes
- Push the changes to your fork
- Submit a Pull Request (PR)
We highly encourage the creation of functional and integration tests to ensure that communications are functioning optimally. Docker Compose is a great tool for this, so feel free to utilize it.
We expect adherence to the coding standards for the Kotlin language. Your code should be clean, well-commented, and conform to best practices. We value readability and clarity over cleverness in coding.
Please familiarize yourself with our Code of Conduct. In essence, we expect respect and courtesy towards all contributors.
If you have any questions about contributing, please don't hesitate to reach out to us. We're here to help!