Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

36 lines (22 loc) · 1.63 KB

Lawnicons contributing guide

Welcome to the Lawnicons contributing guide! This file will tell you what you need to know to contribute to Lawnicons.

Icon guidelines

See the below image for a summary of the icon guidelines. If you don't follow them, a team member will likely request changing the icons.

In addition to the above, the icons must have an outlined (not filled) style. If the original icon has a filled style, you should change the icon to adhere to the guidelines as seen below.

Adding an icon to Lawnicons

Here’s how to add an icon to Lawnicons.

  1. Prepare your icon in the SVG format, adhering to the above guidelines. Use snake case for the filename (e.g., youtube_music.svg).

  2. Add the ready SVG to the svgs directory.

  3. Using Android Studio, convert the SVG to an XML drawable, and add the XML drawable to the app/src/main/res/drawable directory. Use snake case for the drawable name (e.g., youtube_music). You can keep all settings at their defaults.

  4. Add a new line to app/src/main/res/xml/grayscale_icon_map.xml, and map the new icon to a package name and app name. For example:

    <icon drawable="@drawable/twitter" package="com.twitter.android" name="Twitter" />

    A general template is as follows:

    <icon drawable="@drawable/[DRAWABLE NAME]" package="[PACKAGE NAME]" name="[APP NAME]" />

  5. Done! You’re ready to open a pull request. Please set develop as the base branch.