Hello!
At first, thank you for your interest in contributing to Iggy.rs! We're happy to welcome you to the community.
To begin with, feel free to take a look at the list of open issues in the specific repository, whether you're interested in contributing to the core server written in Rust, a particular SDK implemented in a specific language or the Web UI.
For example, you can find the list of open issues for the core Iggy.rs streaming server here. You can filter the issues by labels, e.g. you can find the list of issues marked as good first issue if you're just starting with Iggy.rs.
If you don't find any issue that you'd like to work on, feel free to create a new one. Please, make sure to include the detailed description in the issue, so that other contributors can understand what is the required functionality and how to test it. If it's a bug report, please include the steps to reproduce the bug. Also, keep in mind to attach the appropriate labels to the issue.
If you're working on an issue, please assign yourself to it, so that other contributors know that you're working on it. If you're not sure how to implement the functionality, feel free to ask for help in the comments below the issue and on our Discord server.
In general, the workflow for contributing to the project is as follows:
- Fork the repository
- Create a new branch with the name of the issue you're working on
- Implement the functionality and tests if applicable
- Run the tests for the whole solution (e.g.
cargo testfor the Iggy.rs server) - Run the specific formatter (e.g.
cargo fmtfor the Iggy.rs server) if applicable - Create a pull request to the
masterbranch of the original repository - Include the detailed description of the changes in the PR
- Wait for the CI to pass and for the code review
You might also find an additional, detailed PR guide for the specific repository like this one.