Skip to content

Commit 8fcc108

Browse files
authored
Add small documentation blurb about naming icons (#574)
1 parent 5bb9a98 commit 8fcc108

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1313

1414
- `Select` now supports grouped options with a `title` and option `description`, as well as `BoxProps` for layout styling.
1515
- New components: `InputDate`, `Calendar`
16+
- Documentation added to the icons package README that describes the recommended way to name icons.
1617

1718
### Changed
1819

packages/icons/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,8 @@ All icons should be exported as SVG and placed in the `icons/src/svg` directory.
1515
Icons are automatically built when starting or publishing the style guide, running the tests, building the components or publishing the component package. The icons can be manually built using the command:
1616

1717
`yarn workspace @looker/icons build:icons`
18+
19+
20+
### Naming Icons
21+
22+
When adding a new icon, the name given to the icon should aim to be a succinct and semantic representation of the icon's use, not its artwork. For example, `Warning` not `Triangle With Exclamation Point`. While this rule can be broken in some cases, it is the recommended way to name icons as well as something that will be reviewed when submitting new icons.

0 commit comments

Comments
 (0)