Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: defention of done #1224

Merged
merged 19 commits into from
Aug 21, 2023
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions .github/PULL_REQUEST_TEMPLATE/new-icon.md

This file was deleted.

55 changes: 55 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<!-- Thank you for contributing! -->
ericfennis marked this conversation as resolved.
Show resolved Hide resolved

## What is the purpose of this pull request? <!-- (put an "X" next to an item) -->

- [ ] New Icon
- [ ] Bug fix
- [ ] New Feature
- [ ] Documentation update
- [ ] Other

### Description
<!-- Please insert your description here and provide info about the "what" this PR is contribution -->

### Icon use case <!-- ONLY for new icons, remove this part if not icon PR -->
<!-- What is the purpose of this icon? Please insert a real life use case of icons, text like "it's a "car" icon is not accepted." -->
ericfennis marked this conversation as resolved.
Show resolved Hide resolved

### Alternative icon designs <!-- ONLY for new icons, remove this part if not icon PR -->
<!-- If you have any alternative icon designs, please attach them here. -->

## Icon Design Checklist <!-- ONLY for new icons, remove this part if not icon PR -->

#### Concept <!-- ONLY for new icons -->

- [ ] Icons has a valid use case.
- [ ] Icons do not represent a brand or logo.
- [ ] Icons do not contain hate symbols.
- [ ] Icons do not include religious or political imagery.
- [ ] Icons is at most based on other Lucide icons and not on other people's work
ericfennis marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Icons should not be a rotated or mirrored version of an already existing icon
ericfennis marked this conversation as resolved.
Show resolved Hide resolved

#### Naming <!-- ONLY for new icons -->

- [ ] Icons are named in lowercase and use dashes instead of spaces, for example, `arrow-up` instead of `Arrow Up` and do not end with a number like -2, -3, -4, etc.
- [ ] Icons are named by what they are rather than their use case, for example save should rather be named to floppy-disk
- [ ] Icons that are part of a group are named group-type so, for example, badge-plus is based on badge
- [ ] Provided a meta JSON file in `icons/[iconName].json`
ericfennis marked this conversation as resolved.
Show resolved Hide resolved

#### Design <!-- ONLY for new icons -->

- [ ] Elements have at least 1 pixel padding within the canvas.
- [ ] Icons are visually centered.
- [ ] Icons have a similar optical volume as `circle` and `square`.
- [ ] Icons have similar visual density and level of detail
ericfennis marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Icons are fun and playful.
- [ ] Elements and Arcs centers align with the grid.
- [ ] Corners have a 2px radius or have a good reason for sharpness.
- [ ] Holes and gaps only become invisible with stroke widths of at least 4px.
- [ ] Gaps are closed, so they are 2px when possible.
- [ ] Icons are sharp on low dpi displays
ericfennis marked this conversation as resolved.
Show resolved Hide resolved

## Before Submitting <!-- For every PR! -->

- [ ] Read the [Contributing Guidelines](https://github.com/lucide-icons/lucide/blob/main/CONTRIBUTING.md).
- [ ] Check if there is an existing PR that solves the same issue.
- [ ] Provide a link in the description to the issue you're solving (if there is one).
ericfennis marked this conversation as resolved.
Show resolved Hide resolved