lawnicons icon indicating copy to clipboard operation
lawnicons copied to clipboard

Checklist for self-review

Open x9136 opened this issue 9 months ago • 5 comments

About this discussion

I want to change #1318 a little bit so that it is useful, but at the same time easy to implement.

Due to the fact that difficulties with taking into account the Lawnicons guidelines occur after several PRs, I suggest making a checklist for self-review. This checklist should be sent via github-actions as the first comment on all PRs that have icons.

Such a checklist can be useful for both beginners and contributors who rarely add icons (to remind them of the main points of the guidelines). It will also save some time for reviewers, because they will be less likely to repeat themselves.

Suggestion

Hey! Thanks for the contribution. While there is no reviewer, you can do a self-review. This will help to fix the reasons why the icons may not be suitable for Lawnicons. 

### Canvas and sizes [→](https://github.com/LawnchairLauncher/lawnicons/blob/develop/CONTRIBUTING.md#canvas--sizes)
1. Canvas: `192×192px`.
2. Non-square icons: the long side of the icons should be `160px`.
3. Square icons: `154×154px`.

### Color, stroke width and rounding [→](https://github.com/LawnchairLauncher/lawnicons/blob/develop/CONTRIBUTING.md#foundation)
1. Color: black `#000`.
2. No fill. Base stroke width: `12px`. `14px`, `10px`, `8px` — depending on the shape of the icons. `6px` — for fine details.
3. Rounded ends and joins. 90° corners are rounded by `6-32px`.

### Naming [→](https://github.com/LawnchairLauncher/lawnicons/blob/develop/CONTRIBUTING.md#naming)
1. Names should match the official ones and contain no additional text.
2. If the original name is not in English, then add a localized (or transliterated) one to it using `~~`.
Example: `フールー ~~ Hulu`.
3. The names of the drawables should repeat the names of the apps if nothing prevents it.

### Quality [→](https://github.com/LawnchairLauncher/lawnicons/blob/develop/CONTRIBUTING.md#details)
1. Icons should be easily recognizable.
2. Align icons to [the visual center](https://www.google.com/search?sca_esv=1fcec3f5e0b15e20&q=what+is+visual+center+of+an+icon&tbm=isch&source=lnms).
3. No blackness. Reduce the stroke width or simplify the icons so that there are no noticeable black spots.
4. Avoid close distances between strokes. The icons on the phone screen will be smaller, so the small distances between the strokes will stick together.
5. Avoid drastic changes in stroke widths. When the strokes next to each other differ in width by 4px or more, the icon will look sloppy.

x9136 avatar May 04 '24 21:05 x9136

Hi @x9136 I think this is a good idea and as such, have opened a PR with an action that does this task.

See https://github.com/LawnchairLauncher/lawnicons/pull/2071

Hamster45105 avatar May 05 '24 10:05 Hamster45105

@Hamster45105 Hey! Thanks. I'll send the checklist here tomorrow.

UPD: Below is what it looks like, in the description is the code.

x9136 avatar May 05 '24 10:05 x9136

Hey! Thanks for the contribution. While there is no reviewer, you can do a self-review. This will help to fix the reasons why the icons may not be suitable for Lawnicons.

Canvas and sizes

  1. Canvas: 192×192px.
  2. Non-square icons: the long side of the icons should be 160px.
  3. Square icons: 154×154px.

Color, stroke width and rounding

  1. Color: black #000.
  2. No fill. Base stroke width: 12px. 14px, 10px, 8px — depending on the shape of the icons. 6px — for fine details.
  3. Rounded ends and joins. 90° corners are rounded by 6-32px.

Naming

  1. Names should match the official ones and contain no additional text.
  2. If the original name is not in English, then add a localized (or transliterated) one to it using ~~. Example: フールー ~~ Hulu.
  3. The names of the drawables should repeat the names of the apps if nothing prevents it.

Quality 

  1. Icons should be easily recognizable.
  2. Align icons to the visual center.
  3. No blackness. Reduce the stroke width or simplify the icons so that there are no noticeable black spots.
  4. Avoid close distances between strokes. The icons on the phone screen will be smaller, so the small distances between the strokes will stick together.
  5. Avoid drastic changes in stroke widths. When the strokes next to each other differ in width by 4px or more, the icon will look sloppy.

x9136 avatar May 05 '24 22:05 x9136

Thanks, I've added the proper checklist in now.

Hamster45105 avatar May 06 '24 06:05 Hamster45105

Reopened because it doesn't work. #2098

x9136 avatar May 19 '24 14:05 x9136