diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc4acfd5aa..4e0c9b9446 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,8 +2,8 @@ -* [Contributing code to Matrix](#contributing-code-to-matrix) * [Developer onboarding](#developer-onboarding) +* [Contributing code to Matrix](#contributing-code-to-matrix) * [Android Studio settings](#android-studio-settings) * [Compilation](#compilation) * [Strings](#strings) @@ -28,18 +28,18 @@ -## Contributing code to Matrix - -Please read https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.md - -Element X Android support can be found in this room: [![Element X Android Matrix room #element-x-android:matrix.org](https://img.shields.io/matrix/element-x-android:matrix.org.svg?label=%23element-x-android:matrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#element-x-android:matrix.org). - -The rest of the document contains specific rules for Matrix Android projects - ## Developer onboarding For a detailed overview of the project, see [Developer Onboarding](./docs/_developer_onboarding.md). +## Contributing code to Matrix + +If instead of contributing to the Element X Android project, you want to contribute to Synapse, the homeserver implementation, please read the [Synapse contribution guide](https://element-hq.github.io/synapse/latest/development/contributing_guide.html). + +Element X Android support can be found in this room: [![Element X Android Matrix room #element-x-android:matrix.org](https://img.shields.io/matrix/element-x-android:matrix.org.svg?label=%23element-x-android:matrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#element-x-android:matrix.org). + +The rest of the document contains specific rules for Matrix Android projects. + ## Android Studio settings Please set the "hard wrap" setting of Android Studio to 160 chars, this is the setting we use internally to format the source code (Menu `Settings/Editor/Code Style` then `Hard wrap at`). diff --git a/docs/_developer_onboarding.md b/docs/_developer_onboarding.md index 738bd12430..525ab96fc0 100644 --- a/docs/_developer_onboarding.md +++ b/docs/_developer_onboarding.md @@ -10,7 +10,7 @@ * [Sync](#sync) * [Rust SDK](#rust-sdk) * [Matrix Rust Component Kotlin](#matrix-rust-component-kotlin) - * [Build the SDK locally](#build-the-sdk-locally) + * [Building the SDK locally](#building-the-sdk-locally) * [The Android project](#the-android-project) * [Application](#application) * [Jetpack Compose](#jetpack-compose) @@ -107,7 +107,7 @@ This is the goal of https://github.com/matrix-org/matrix-rust-components-kotlin. This repository is used for distributing kotlin releases of the Matrix Rust SDK. It'll provide the corresponding aar and also publish them on maven. -Most of the time you want to use the releases made on maven with gradle: +Most of the time **you want to use the releases made on maven with gradle**: ```groovy implementation("org.matrix.rustcomponents:sdk-android:latest-version") @@ -115,7 +115,9 @@ implementation("org.matrix.rustcomponents:sdk-android:latest-version") You can also have access to the aars through the [release](https://github.com/matrix-org/matrix-rust-components-kotlin/releases) page. -#### Build the SDK locally +#### Building the SDK locally + +If you want to make changes to the SDK or test them before integrating it with your codebase, you can build the SDK locally too. Prerequisites: * Install the Android NDK (Native Development Kit). To do this from within