Skip to content

Commit

Permalink
Format with prettier, add alt text
Browse files Browse the repository at this point in the history
  • Loading branch information
JovannMC committed May 6, 2024
1 parent df79c37 commit d231012
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Lawnchair Launcher Contributing Guidelines

<img title="" src="https://raw.githubusercontent.com/validcube/lawnchair/pave-path/.github/lawnchair_round.png" alt="" width="100" data-align="inline">
<img title="Lawnchair Launcher logo" alt="Lawnchair Launcher logo" src="https://raw.githubusercontent.com/validcube/lawnchair/pave-path/.github/lawnchair_round.png" width="100" data-align="inline">

First and foremost, welcome to the **Lawnchair Launcher** Contributing Guidelines! This document will contain everything you'll need to contribute to the **Lawnchair Launcher** project.
First and foremost, welcome to the **Lawnchair Launcher** Contributing Guidelines! This document will contain everything you'll need to contribute to the `Lawnchair Launcher` project.

## Before you start!

Expand All @@ -14,13 +14,13 @@ For translation, you only need to know one tool, [Crowdin](https://lawnchair.cro

Here are few tips for starters:

* When using quotation marks, insert the symbols specific to the target language, as listed in this [this summary table](https://en.wikipedia.org/wiki/Quotation_mark#Summary_table);
- When using quotation marks, insert the symbols specific to the target language, as listed in this [this summary table](https://en.wikipedia.org/wiki/Quotation_mark#Summary_table);

* Lawnchair uses title case for some English UI text while other languages do not use title case; opt for sentence case instead;
- Lawnchair uses title case for some English UI text while other languages do not use title case; opt for sentence case instead;

* Some English terminology may have not have commonly-used equivalents in other languages. In such cases, use short descriptive phrases—for example, the equivalent of `bottom row` for `dock`;
- Some English terminology may have not have commonly-used equivalents in other languages. In such cases, use short descriptive phrases—for example, the equivalent of `bottom row` for `dock`;

* Some languages (e.g. `French`) has variations of words depending if it's masculine or feminine (gender-specific); we recommend to opt for gender-neutral words instead.
- Some languages (e.g. `French`) has variations of words depending if it's masculine or feminine (gender-specific); we recommend to opt for gender-neutral words instead.

### Code

Expand All @@ -36,11 +36,11 @@ To build `Lawnchair Launcher`, select the `lawnWithQuickstepDebug` build type. S

Here are some contribution tips to help you get started:

* Always make sure that you're up-to-date with `Lawnchair Launcher` by setting your branch to `14-dev` or newer;
- Always make sure that you're up-to-date with `Lawnchair Launcher` by setting your branch to `14-dev` or newer;

* Make sure your code is logical and well-formatted. If using Kotlin, see `Coding conventions` in the [Kotlin documentation](https://kotlinlang.org/docs/coding-conventions.html);
- Make sure your code is logical and well-formatted. If using Kotlin, see `Coding conventions` in the [Kotlin documentation](https://kotlinlang.org/docs/coding-conventions.html);

* [The `lawnchair` package](https://github.com/LawnchairLauncher/lawnchair/tree/14-dev/lawnchair) houses Lawnchair’s own code, whereas [the `src` package](https://github.com/LawnchairLauncher/lawnchair/tree/14-dev/src) includes a clone of the Launcher3 codebase with modifications. Generally, place new files in the former, keeping changes to the latter to a minimum.
- [The `lawnchair` package](https://github.com/LawnchairLauncher/lawnchair/tree/14-dev/lawnchair) houses Lawnchair’s own code, whereas [the `src` package](https://github.com/LawnchairLauncher/lawnchair/tree/14-dev/src) includes a clone of the Launcher3 codebase with modifications. Generally, place new files in the former, keeping changes to the latter to a minimum.

#### Version

Expand All @@ -62,18 +62,18 @@ These makes up the first two sectors of the version code, `Android 11` will be `

Depending on which status the `Lawnchair Launcher` is on, it will have an impact on the 3rd and 4th sectors of the version code. For example, alpha 4 for the `Lawnchair Launcher` will be `XX_XX_01_04`.

| Status | Fields 3 |
| ------------------ | -------- |
| Alpha | 01 |
| Beta | 02 |
| Release candidate | 03 |
| Release | 04 |
| Status | Fields 3 |
| ----------------- | -------- |
| Alpha | 01 |
| Beta | 02 |
| Release candidate | 03 |
| Release | 04 |

## Quick links

- [News](https://t.me/lawnchairci)
- [Lawnchair on Twitter](https://twitter.com/lawnchairapp)
- [Website](https://lawnchair.app)
- [_XDA_ thread](https://forum.xda-developers.com/t/lawnchair-customizable-pixel-launcher.3627137/)
- [News](https://t.me/lawnchairci)
- [Lawnchair on Twitter](https://twitter.com/lawnchairapp)
- [Website](https://lawnchair.app)
- [_XDA_ thread](https://forum.xda-developers.com/t/lawnchair-customizable-pixel-launcher.3627137/)

You can view all our links in the [Lawnchair Wiki](https://github.com/LawnchairLauncher/lawnchair/wiki).

0 comments on commit d231012

Please sign in to comment.