Skip to main content

Contribution guidelines

Thanks for considering contributing to FlorisBoard!

There are several ways to contribute to FlorisBoard. This document provides some general guidelines for each type of contribution.

The FlorisBoard community is international, as such we require all contributions, including issues, pull requests, and participation in the Matrix chat to be in English and follow the code of conduct. Contributions not adhering to these requirements will be dismissed. Thanks for making the FlorisBoard community an inclusive and safe space for everyone!

Non-code contributions​

Translations​

To make FlorisBoard accessible in as many languages as possible, the platform Crowdin is used to crowdsource and manage translations. The list of languages in Crowdin covers a good range of languages, but feel free to email florisboard@patrickgold.dev to request a new language.

[!IMPORTANT] This is the only source of translations - PRs that add/update translations are not accepted.

Bug reporting​

Allows us to see where FlorisBoard has flaws and should be improved to maximize stability and user experience. To make this process as smooth as possible, please use the pre-made bug report template. This makes it easy for us to understand what the bug is and how to solve it.

Capturing error logs​

Logs are captured by FlorisBoard's crash handler, which gives you the ability to copy it to the clipboard and paste it in the crash report issue template. This is the preferred way to capture logs.

Alternatively, you can also use ADB (Android Debug Bridge) to capture the error log. This is recommended for experienced users only.

Feature proposals​

Use the feature proposal issue template to suggest a new idea or improvement for this project.

Feedback​

You can give general feedback directly here on GitHub. This is the preferred way to give feedback, as it allows not only for me to read and respond to feedback, but for everyone in this community.

Code contributions​

You are always welcome to contribute new features or work on existing issues, there are a lot to choose from :) It is always best to quickly ask if someone is already working on this issue to avoid duplicate issues.

[!NOTE] If you intend to implement a bigger feature please coordinate with us so we can prevent that there's a major difference in expected implementation.

If you are overwhelmed by the code don't hesitate to ask for help in the dev chat or the discussions tab! Some issues are also marked as good first issue, which are easy to do tasks.

System requirements for development​

  • Desktop PC with Linux or WSL2 (Windows)
    • MacOS and Windows without WSL2 probably works too however there's no official support
  • At least 16GB of RAM (because of Android Studio / IntelliJ)
  • The following tools must be installed:
    • Android Studio (bundles SDK and NDK) or IntelliJ with Android and Compose plugin
    • Java 17
    • CMake 3.22+
    • Clang 15+
    • Git
    • Rust
  • Utilities (optional)
    • Python 3.10+
    • Bash, realpath, grep, ...

Manual build without Android Studio​

If you want to manually build the project without Android Studio you must ensure that the Android SDK and NDK are properly installed on your system. Then issue

./gradlew clean && ./gradlew assembleDebug

and Gradle should take care of every build task.

Donating​

You can also show your support by buying me a coffee, so I can stay up all night and chase away bugs or add new cool stuff :) See the Sponsors button for available options!