> For the complete documentation index, see [llms.txt](https://docs.lawnchair.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lawnchair.app/developers/introduction/get-started.md).

# 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

* [Preview version of Anroid Studio](https://developer.android.com/studio/preview)
* 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.

   ```bash
   git clone --recursive https://github.com/LawnchairLauncher/lawnchair.git
   ```
2. Open the project in Android Studio.
3. Select the `lawnWithQuickstepGithubDebug` build variant.

{% hint style="info" %}
If modules ending in `lib` fail to load, run `git submodule update --init --recursive`.
{% endhint %}

### Creating your first contribution

{% stepper %}
{% step %}

#### Read our contribution quality guidelines

Before doing anything else, review our contribution quality guidelines which details what we expect when you make any change.

<a href="/community/about/quality-guidelines.md" class="button primary" data-icon="memo">Contribution quality guidelines</a>
{% endstep %}

{% step %}

#### 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](https://github.com/LawnchairLauncher/lawnchair/issues) 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](/community/get-involved/community-channels.md) before writing code.
{% endstep %}

{% step %}

#### 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](https://github.com/LawnchairLauncher/lawnchair/pulls).
4. Follow the PR template and explain what changed.

{% hint style="info" %}
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.
{% endhint %}

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.
{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.lawnchair.app/developers/introduction/get-started.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.