Skip to content

Latest commit

 

History

History
111 lines (80 loc) · 6.68 KB

CONTRIBUTING.md

File metadata and controls

111 lines (80 loc) · 6.68 KB
Raw

Lawnchair Contributing Guidelines

First and foremost, welcome to the Lawnchair Contributing Guidelines!

💫 Bug reports & feature requests

For bug reports, please describe the bug in detail to the best of your ability and steps on how to reproduce it. If applicable, attach log files.

For feature requests, please describe the feature you'd like to see added to Lawnchair. If applicable, attach log files.

Please make sure to be civil during discussion of your contribution (refer to the Code of Conduct)

🌐 Translation

For translation, visit Lawnchair on Crowdin and follow these tips:

  • When using quotation marks, insert the symbols specific to the target language, as listed in this this summary table;
  • 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) have variations of words depending if it's masculine or feminine (gender-specific); we recommend opting for gender-neutral words instead.

🧑‍💻 Code

Note

For Lawnchair 9 to 13, see the branches with the 9- to 13- prefixes respectively.

For code, it's highly recommended that you use Android Studio, know Java or preferably Kotlin, and Git.

Important

You can use Git to clone the repository; ensure that you include the project’s submodules using the recursive flag:

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

To build Lawnchair, select the lawnWithQuickstepGithubDebug build type. Should you face errors relating to the iconloaderlib and searchuilib projects, run git submodule update --init --recursive.

Here are some contribution tips to help you get started:

  • Always make sure that you're up-to-date with Lawnchair by setting your base branch to 14-dev.
  • Make sure your code is logical and well-formatted. If using Kotlin, see “Coding conventions” in the Kotlin documentation;
  • The lawnchair package houses Lawnchair’s own code, whereas the src package includes a clone of the Launcher3 codebase with modifications. Generally, place new files in the former, keeping changes to the latter to a minimum.

Additional documentation

Versioning scheme

As of #4361, Lawnchair’s version code is separated by four parts:

  1. Android's major version
  2. Android's minor version
  3. Lawnchair's development status
  4. Lawnchair's development version
Android's major & minor versions

These make up the first two parts of the version code. For example: Android 11 will be 11_00_XX_XX while Android 12.1 will be 12_01_XX_XX.

Development status & version

The third part of the version code indicates Lawnchair's stability status, while the fourth part indicates the version number.

For example, Alpha 4's version code will be XX_XX_01_04.

See the table below detailing the release type:

Status Stage
Alpha 01
Beta 02
Release Candidate 03
Release 04

String naming

Strings names in strings.xml should follow this format:

Type Format Example usage Actual string Other information
Generic word $1 disagree_or_agree Disagree or agree Should only be used if it doesn't fit the below categories
Action $1_action apply_action Apply Any generic action verb can fit here
Preference or popup label
Preference headers		 $1_label folders_label Folders
Preference or popup description $1_description folders_description Row and column count
Preference choice $1_choice off_choice Off
Feature string (feature_name)_$1 colorpicker_hsb HSB Feature strings are strings that are confined to a specific feature. Examples include the gesture and color picker.
Launcher string $1_launcher device_contacts_launcher Contacts from device Strings that are specific to the Launcher area