Skip to content
This repository was archived by the owner on Oct 18, 2024. It is now read-only.

Commit 3885d24

Browse files
committed
Updated contribution guidelines
1 parent 59ec6c3 commit 3885d24

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,46 @@
33
This document outlines how to propose a change to AndrodIDE. By contributing to this project, you
44
agree to abide the terms specified in [CODE OF CONDUCT](./CODE_OF_CONDUCT.md).
55

6-
## Propose a change
6+
## Requirements
77

8-
To contribute to this project,
8+
- Android Studio.
9+
- JDK 11 (prefer the one bundled with Android Studio). Newer versions are not recommended.
910

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.
1512

16-
## Note
13+
Open the project in Android Studio. No extra steps are needed for this.
1714

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.
2616

2717
## Source code format
2818

2919
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
3123
execute `./gradlew formatJavaSources` in terminal to format all Java source files using Google Java
3224
Format.
3325
**This will commit the changes as well**.
3426

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+
3539
## Issues & Pull requests
3640

3741
Use the issue/PR templates when possible. Provide a proper title and a clear description for the
3842
issue/PR. For bug reports, provide a step-by-step procedure to reproduce the issue. Always put crash
3943
logs, build outputs, etc in `code blocks`.
4044

45+
46+
## Contact us
4147
If you want to discuss anything about the project, you can discuss it in
4248
the [Telegram group](https://t.me/androidide_discussions).

0 commit comments

Comments
 (0)