Skip to content

Commit 2ccd69b

Browse files
authored
docs: CONTRIBUTING.md: clarify what should be generated, using official colours and add a TOC (#630)
1 parent 95b7a00 commit 2ccd69b

1 file changed

Lines changed: 28 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,28 @@
22

33
Thank you for your contribution!
44

5+
<!--
6+
https://github.com/jonschlinkert/markdown-toc
7+
markdown-toc --maxdepth=3 -i CONTRIBUTING.md
8+
-->
9+
10+
<!-- toc -->
11+
12+
- [Prerequisites](#prerequisites)
13+
* [stylua](#stylua)
14+
* [luacheck](#luacheck)
15+
- [Adding icons](#adding-icons)
16+
- [Building](#building)
17+
* [Generate](#generate)
18+
* [Validate](#validate)
19+
- [Test](#test)
20+
- [Documentation](#documentation)
21+
- [Pull Request](#pull-request)
22+
- [Subject](#subject)
23+
- [Browser Font](#browser-font)
24+
25+
<!-- tocstop -->
26+
527
## Prerequisites
628

729
Code is formatted using *stylua* and linted using *luacheck*.
@@ -40,11 +62,11 @@ If you experience `luarocks` dependency issues installing `luacheck`, you may ne
4062
luarocks config --local lua_version 5.1
4163
```
4264

43-
## Adding icons
65+
## Adding Or Updating Icons
4466

45-
Add or update icons in `lua/nvim-web-devicons/default/` directory
67+
Add or update icons in `lua/nvim-web-devicons/default/` directory. Build after making your changes.
4668

47-
There are five files where icons can be added:
69+
Icons must be added to `/default/` files only. The `/light/` files are automatically generated and should not be modified.
4870

4971
1. `icons_by_filename.lua`
5072
2. `icons_by_file_extension.lua`
@@ -69,8 +91,9 @@ Each icon must have the following structure (this is an example):
6991

7092
- `icon` glyph
7193
- `color` must contain a color in the html notation
72-
- `cterm_color` must contain a number (any number)
73-
- the correct value for `cterm_color` will be generated by the script in next step
94+
- it is desirable to use the "official" icon color: look at the website for a style guide or pick the colour from a logo
95+
- `cterm_color` must contain a placeholder (any number)
96+
- the value for `cterm_color` will be generated by the script in next step
7497
- `name` must only contain alphanumeric characters (don't use `/`, `-`, `_`)
7598

7699
## Building

0 commit comments

Comments
 (0)