Contribute to Readeck

So you'd like to contribute to Readeck? Awesome! There are many ways to help with a contribution and most of them don't require any coding knowledge.

Report issues

The easiest way to contribute and help Readeck is to report issues you may encounter. This helps improving the application's quality and fix problems other users might be facing.

To report an issue, visit Readeck's Repository. You'll need a Codeberg or Github account to connect and report bugs.

Engage with the community

While reporting issues is important, not all discussions need to take place on the code repository. Should you want to discuss ideas, new features, ask questions or help other users, the Readeck Forum is the right place for you.

Translations

If Readeck is not available in your language, why not submit a translation?

Application

Readeck itself uses Gettext for all its translation purposes. You can improve an existing translation or submit a new one on Codeberg Translate.

If you prefer to clone the code repository and submit a pull request, it's fine too but, please, use a tool like Poedit to do so.

Documentation

Readeck's embedded documentation consists of markdown files. To translate them, you must clone the repository and copy the files from docs/src/en-US to the target language (ie. docs/src/fr-FR for a French translation).

Once you're happy with your work, you can submit a pull request.

Code contributions

Finally, if you'd like to contribute code, you can submit a pull request.

Follow the instructions to setup your development environment so you'll get ready almost effortlessly.