Skip to content

Commit

Permalink
Updated contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
itsaky committed Sep 28, 2022
1 parent 59ec6c3 commit 3885d24
Showing 1 changed file with 23 additions and 17 deletions.
40 changes: 23 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,46 @@
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).

## Propose a change
## Requirements

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

- Fork the repo.
- Clone the forked repo to your local machine.
- Open the project in Android Studio.
- Make your changes.
- Create a pull request.
## Build the project.

## Note
Open the project in Android Studio. No extra steps are needed for this.

`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.
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
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.
- Make your changes.
- Create a pull request. Give a proper title and description to your PR.

## Issues & Pull requests

Use the issue/PR templates when possible. Provide a proper title and a clear description for the
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).

0 comments on commit 3885d24

Please sign in to comment.