|
3 | 3 | This document outlines how to propose a change to AndrodIDE. By contributing to this project, you |
4 | 4 | agree to abide the terms specified in [CODE OF CONDUCT](./CODE_OF_CONDUCT.md). |
5 | 5 |
|
6 | | -## Propose a change |
| 6 | +## Requirements |
7 | 7 |
|
8 | | -To contribute to this project, |
| 8 | +- Android Studio. |
| 9 | +- JDK 11 (prefer the one bundled with Android Studio). Newer versions are not recommended. |
9 | 10 |
|
10 | | -- Fork the repo. |
11 | | -- Clone the forked repo to your local machine. |
12 | | -- Open the project in Android Studio. |
13 | | -- Make your changes. |
14 | | -- Create a pull request. |
| 11 | +## Build the project. |
15 | 12 |
|
16 | | -## Note |
| 13 | +Open the project in Android Studio. No extra steps are needed for this. |
17 | 14 |
|
18 | | -`Java 11` is required to build the project. |
19 | | - |
20 | | -Building AndroidIDE in AndroidIDE itself is also possible. But that might require some |
21 | | -modifications. |
22 | | - |
23 | | -If you face `AAPT2` issue while building AndroidIDE in the IDE itself, specify |
24 | | -the `android.aapt2FromMavenOverride` property in `gradle.properties` with location of `aapt2` binary |
25 | | -from Android SDK. However, this is an **experimental** property. |
| 15 | +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. |
26 | 16 |
|
27 | 17 | ## Source code format |
28 | 18 |
|
29 | 19 | The source code must have `2-space` indentation (soft tab). Java source code is formatted |
30 | | -using `google-java-format` with `GOOGLE` style formatting. You can |
| 20 | +using `google-java-format` with `GOOGLE` style formatting. |
| 21 | + |
| 22 | +You can |
31 | 23 | execute `./gradlew formatJavaSources` in terminal to format all Java source files using Google Java |
32 | 24 | Format. |
33 | 25 | **This will commit the changes as well**. |
34 | 26 |
|
| 27 | +## Propose a change |
| 28 | + |
| 29 | +Before proposing a change, it is always recommended to open an issue and discuss it with the maintainers. |
| 30 | + |
| 31 | +To contribute to this project, |
| 32 | + |
| 33 | +- Fork the repo. |
| 34 | +- Clone the forked repo to your local machine. |
| 35 | +- Open the project. |
| 36 | +- Make your changes. |
| 37 | +- Create a pull request. Give a proper title and description to your PR. |
| 38 | + |
35 | 39 | ## Issues & Pull requests |
36 | 40 |
|
37 | 41 | Use the issue/PR templates when possible. Provide a proper title and a clear description for the |
38 | 42 | issue/PR. For bug reports, provide a step-by-step procedure to reproduce the issue. Always put crash |
39 | 43 | logs, build outputs, etc in `code blocks`. |
40 | 44 |
|
| 45 | + |
| 46 | +## Contact us |
41 | 47 | If you want to discuss anything about the project, you can discuss it in |
42 | 48 | the [Telegram group](https://t.me/androidide_discussions). |
0 commit comments