diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3be699346..6a7a65c9f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,34 +3,38 @@ This document outlines how to propose a change to AndrodIDE. By contributing to this project, you agree to abide the terms specified in [CODE OF CONDUCT](./CODE_OF_CONDUCT.md). +## Requirements + +- Android Studio. +- JDK 11 (prefer the one bundled with Android Studio). Newer versions are not recommended. + +## Build the project. + +Open the project in Android Studio. No extra steps are needed for this. + +It is possible to build AndroidIDE in AndroidIDE iteself. But, as it might a too heavy task for an Android device to build the AndroidIDE project, Android Studio is always recommended. + +## Source code format + +The source code must have `2-space` indentation (soft tab). Java source code is formatted +using `google-java-format` with `GOOGLE` style formatting. + +You can +execute `./gradlew formatJavaSources` in terminal to format all Java source files using Google Java +Format. +**This will commit the changes as well**. + ## Propose a change +Before proposing a change, it is always recommended to open an issue and discuss it with the maintainers. + To contribute to this project, - Fork the repo. - Clone the forked repo to your local machine. -- Open the project in Android Studio. +- Open the project. - Make your changes. -- Create a pull request. - -## Note - -`Java 11` is required to build the project. - -Building AndroidIDE in AndroidIDE itself is also possible. But that might require some -modifications. - -If you face `AAPT2` issue while building AndroidIDE in the IDE itself, specify -the `android.aapt2FromMavenOverride` property in `gradle.properties` with location of `aapt2` binary -from Android SDK. However, this is an **experimental** property. - -## Source code format - -The source code must have `2-space` indentation (soft tab). Java source code is formatted -using `google-java-format` with `GOOGLE` style formatting. You can -execute `./gradlew formatJavaSources` in terminal to format all Java source files using Google Java -Format. -**This will commit the changes as well**. +- Create a pull request. Give a proper title and description to your PR. ## Issues & Pull requests @@ -38,5 +42,7 @@ Use the issue/PR templates when possible. Provide a proper title and a clear des issue/PR. For bug reports, provide a step-by-step procedure to reproduce the issue. Always put crash logs, build outputs, etc in `code blocks`. + +## Contact us If you want to discuss anything about the project, you can discuss it in the [Telegram group](https://t.me/androidide_discussions). \ No newline at end of file