Get started

Read this page once you have decided to contribute code. It covers local setup and a realistic path to a small first contribution.

Prerequisites

• Android Studio

• Git

• At least 8 GB of RAM

  • 16 GB of RAM is recommended to comfortably multitask with other apps.

macOS or Linux is recommended.

Setup steps

1. Clone the repository with the --recursive flag.

   git clone --recursive https://github.com/LawnchairLauncher/lawnchair.git

2. Open the project in Android Studio.

3. Select the lawnWithQuickstepGithubDebug build variant.

If modules ending in lib fail to load, run git submodule update --init --recursive.

Creating your first contribution

1

Pick your first change

1. Pick a bug that affects you or a very small feature.

2. Prefer changes you can explain in one sentence.

3. Avoid broad refactors or multi-area rewrites for your first PR.

Check the issue tracker before you start. If your bug or idea is not listed, consider opening an issue first.

If you are unsure whether a change is a good fit, ask in the community channels before writing code.

2

Open your first PR

1. Make your change in a new branch.

2. Test it in a debug build on a device or emulator.

3. Open a pull request on GitHub.

4. Follow the PR template and explain what changed.

Reviews can take anywhere from a day to several weeks. The project is maintained by a small volunteer team. If your PR has no activity after two weeks, a gentle ping is fine.

If review feedback comes in, try to address it with small follow-up commits. If you get stuck, ask for clarification or close the PR and come back later.