Contribute

What's your way of contributing?

Iris is an open-source project that welcomes contributions from developers, designers, testers, translators, and users.

There are various ways you can contribute to the project, depending on your skills and interests. Here are some ideas to get you started.

Bug reports and feature requests

You can report any bugs you encounter while using Iris. A bug could be related to the functionality of the app, the user interface, the documentation, or any other aspect of the user experience.

To report a bug or feature request, please create an issue.

You can also comment on the existing issues to make the feature requests and bug request more comprehensive.

But before you do it:

1. Make sure to check if it has already been reported.

2. Please provide detailed information such as why the bug is a problem, how to reproduce it, your operating system, client, version, and if possible, a screenshot or video capture.

3. Please note that security vulnerabilities should be reported by contacting our development team directly.

Beta testing

If you are interested in testing the new features visit beta.iris.to for the latest version.

Iris Github Actions page shows the latest updates where you can find the details and the code changes. Master branch is the beta-version and production is the official version.

Report any issues you find with as much details as possible.

Code patches and enhancements

If you have the skills to improve the Iris codebase, you can submit patches, enhancements, or new features.

You can find the source code on the Iris GitHub repository and make a Pull Request (PR).

For ideas, check the existing feature requests, suggestions and bugs.

Documentation improvements

If you have expertise in technical writing, you can help to improve the Iris documentation.

This could include fixing typos and grammar, clarifying instructions, or adding new content.

Translations

Iris is a multilingual app, and we need help from translators to make it accessible to more people.

If you speak a language other than English, you can contribute by translating the app's user interface, documentation, or other materials.

The app language strings can be found here.

UI/UX enhancements

If you have design skills, you can help to improve the Iris user interface/experience. This could include creating new visual designs, improving the usability of the app, or creating new themes.

Telegram group

Iris has a Telegram group for contributors, join now.