If you're interested in contributing to the Ruma project, this page offers some pointers on how to get started.

While we wait for the async networking ecosystem in Rust to stabilize, there isn't work being done on the main homeserver component of Ruma. (See project status for more details on this.) The client and supporting libraries can still be improved, however.

The most significant thing you can do to help the project is to try to build something using it. Since the homeserver is not functional at this point, this would mean building something like a bot or GUI client using the ruma-client library. As you work, you can help by opening issues and/or pull requests on the relevant Ruma libraries as issues come up. This will help ensure that Ruma is suitable for real-world use cases.

If you are more interested in contributing code to the project without building your own software, there are a couple places you might spend your time.

If you have experience with cryptography and/or C programming, you can work on Rust support for Olm, the library that supports end-to-end encryption in Matrix. It's possible that the maintainers of Olm would be interested in Rust support within Olm itself. If not, you could work on exposing Olm's C API as safe Rust. One such project already exists: olm-rs. olm-rs might need some additional help. If you're very confident in your skills with implementing cryptographic algorithms, you could attempt to port Olm to Rust directly, though it's not clear if this would be possible without any C code at all.

The second major area where code contributions would help would be to work on equivalents of ruma-client-api for the other Matrix APIs (e.g. federation.) ruma-client-api is the library that defines the Rust interface for all the HTTP endpoints in the Matrix client-server API. An equivalent library will eventually be needed for the other Matrix APIs.

GitHub issues across all of Ruma's repositories are tagged with "effort" levels, so looking for issues tagged with "effort/easy" is also a good way to find smaller, entry-level issues to take on.

Lastly, if you want to offer financial support to the developers of Ruma, you can donate to Ruma on Liberapay.

Thank you for your interest in contributing to Ruma!

The source code and content of this website are free and available under the MIT license: www.ruma.io