UNPKG

@carbon/pictograms

Version:

Pictograms for digital and software products using the Carbon Design System

github.com/carbon-design-system/carbon

carbon-design-system/carbon

68 lines (51 loc) • 2.96 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# Contributing <!-- prettier-ignore-start --> <!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> ## Table of Contents - [Metadata](#metadata) - [`pictograms.yml`](#pictogramsyml) - [`categories.yml`](#categoriesyml) - [`deprecated.yml`](#deprecatedyml) <!-- END doctoc generated TOC please keep comment here to allow auto update --> <!-- prettier-ignore-end --> ## Metadata The information for each pictogram that is used by our website is hosted in [YAML](https://en.wikipedia.org/wiki/YAML) files inside of the pictograms package, located [here](../). Different files hold different types of information for our pictograms. The most notable ones include: - [Icon name, friendly name, and aliases](../pictograms.yml) - [Categories for pictograms](../categories.yml) - [Deprecations](../deprecated.yml) You can edit each of these files using GitHub UI by clicking on the "edit" pictogram. We go into more detail for each of the file formats below. ### `pictograms.yml` This file contains information about a pictogram's name, "friendly" name, and aliases. The friendly name for an pictogram is what is displayed to an end-user on our website. The name for an pictogram matches the asset name in our folder of SVG assets. Finally, aliases for a pictogram are used during search as alternative ways of finding the pictogram. ### `categories.yml` This file contains grouping information for pictograms and the categories, or subcategories, to which they belong. Feel free to add or update categories, subcategories, members, and more in this file. ### `deprecated.yml` This file contains information mapping assets that have changed in the current release. Typically, this file will indicate which pictograms have been renamed or removed. This file contains a list of deprecated pictograms with a required `name` field alongside an optional `reason` field. You can use the `reason` field to indicate that: - The icon has been replaced by an alternate icon - The icon has been removed Use `deprecated.yml` when assets are renamed to indicate the change. This will hide the deprecated name from display on the web site, and signal to teams that the originally named file is a candidate for future removal. It's recommended that you also add the deprecated name to `aliases` for the asset in `icons.yml`, so that the new asset name will be a search result for the deprecated name. We then persist both named assets in the repo for 2 releases to allow teams time to migrate to the new asset name. When an asset is removed with no replacement, it is also captured in `deprecated.yml`. Removed icon assets represent breaking changes and should be carefully considered. To remove an asset, add the asset name to `deprecated.yml`; we then persist the to-be removed assets in the repo for 2 releases to allow teams time to migrate to a different asset.