Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
116 lines (75 loc) · 5.35 KB

CONTRIBUTING.md

File metadata and controls

116 lines (75 loc) · 5.35 KB
Raw

Lawnicons contributing guide

Welcome to the Lawnicons contributing guide!

In case of unclear wording, ask us in our Discord. If you find errors or want to suggest improvements in the guide itself, create an issue.

Our Discord

Contributing code

Code-related contributions are welcome. Significant changes to the UI should be discussed in our Discord. Generally, we want to keep things clean and simple.

Visit the Lawnicons developer wiki for developer information regarding Lawnicons.

Lawnicons developer wiki

Contributing icons

You can contribute icons, fulfill icon requests, add missing app IDs, refine existing icons, clean up dead apps, and remove duplicates.

  1. Create an icon (*.svg) following the design guidelines. #
  2. Find the app ID to link with your icon. #
  3. On the Lawnicons repo page, click Fork, then clone it locally with GitHub Desktop.
  4. Add the icon and the app ID to your local copy and push the changes. #
  5. Create a pull request and wait for review. #

Lawnicons dashboard

Create icons

Create icons in a vector graphics editor and save them as SVG. We recommend Figma because it has easier quality control. You can use Advanced SVG Export to save optimized SVGs in Figma.

Design guidelines • Figma • Advanced SVG Export

How to find app IDs

Every app has a unique app ID, which consists of a package and an activity separated by /. App IDs allow you to link icons and apps.

App ID: app.lawnchair.lawnicons/app.lawnchair.lawnicons.MainActivity
Package: app.lawnchair.lawnicons
Activity: app.lawnchair.lawnicons.MainActivity

Lawnicons

Install and open Lawnicons → Tap ⋮ → Tap Request icons → Select icons → Tap Copy App IDs in the split button's menu and save it wherever it's convenient.

Download Lawnicons

Alternatives

Icon Request • Icon Pusher

Android Debug Bridge (adb)

  1. Connect your Android device or emulator to your laptop/desktop PC that has adb installed.
  2. Open the app whose details you want to inspect (e.g. Telegram).
  3. Open a new Command Prompt or Terminal window and input adb devices.
  4. Finally, type the below-given command to get the information about the currently open app.

How to install ADB

Mac or Linux

adb shell dumpsys window | grep 'mCurrentFocus'

Windows

adb shell dumpsys window | findstr "mCurrentFocus"

Adding icons to Lawnicons

Icon: lawnicons.svg
App name: Lawnicons
App ID: app.lawnchair.lawnicons/app.lawnchair.lawnicons.MainActivity

Let's imagine that you have an icon in SVG format, an app name and an app ID.

  1. Fork the Lawnicons repository.
  2. Clone the fork via GitHub Desktop.
  3. Open it with a file explorer.
  4. Сopy lawnicons.svg to the svgs/ folder.
  5. Open app/assets/appfilter.xml and add a new line using the same template as the existing lines.
  6. Save changes and push it to your fork via GitHub Desktop.
  7. Open your fork in a web browser and create a PR: Contribute → Open pull request.
  8. Make sure that the build went without errors and common issues are fixed, then await review.

Tip

View on YouTube

GitHub Desktop • How to find app IDs

Icon reviews

  1. The review bot gives feedback on most of the common issues. The contributor is expected to fix them.
  2. Once the bot has nothing left to flag, a maintainer reviews the remaining issues (5 icons at a time) or fixes minor things directly.
  3. Icons get added to Lawnicons when all issues are resolved.

PRs with long-ignored issues are closed automatically.

Reviews keep icon quality high and filter out rushed attempts. This saves time for everyone involved. To review icons, you should be able to create at least 20 random icons flawlessly in one go. That demonstrates solid knowledge of the design guidelines.

Future contributions

Please keep your repository up to date if you plan to create more than one PR, otherwise you may drag the commit history through all your PRs. There are two main ways to do this:

  • Open Terminal on the local copy of your repository via GitHub Desktop. Run git reset --hard upstream/develop. Overwrite your repository with your local copy via GitHub Desktop: Force push origin.
  • Or delete your repository and start the contribution process from scratch.

If you plan to contribute icons regularly, it's worth learning icontool.py.