Skip to content

Commit 8033534

Browse files
authored
docs: CONTRIBUTING.md: add Validate step (#619)
1 parent cc8be1e commit 8033534

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ Each icon must have the following structure (this is an example):
5656

5757
Note: Ensure your current working directory is the repo root.
5858

59+
### Generate
60+
5961
Following your changes, please run:
6062

6163
```sh
@@ -79,6 +81,16 @@ make style-fix
7981

8082
Please commit all files from `lua/nvim-web-devicons/default/`, `lua/nvim-web-devicons/light/` end `lua/nvim-web-devicons/filetypes.lua`
8183

84+
### Validate
85+
86+
After committing, please run:
87+
88+
```sh
89+
make colors-check
90+
```
91+
92+
This is run in CI and ensures that generation was correct by re-running it and validating that no changes were made.
93+
8294
## Test
8395

8496
Run `:NvimWebDeviconsHiTest` to view the icons and their highlighting.
@@ -95,8 +107,7 @@ When modifying or adding API, please update [Usage](README.md#Usage)
95107

96108
Please reference any issues in the description e.g. "resolves #1234", which will be closed upon merge.
97109

98-
Please check "allow edits by maintainers" to allow *nvim-web-devicons* maintainers to make small changes
99-
such as documentation tweaks.
110+
Please check "allow edits by maintainers" to allow *nvim-web-devicons* maintainers to make small changes such as documentation tweaks.
100111

101112
## Subject
102113

0 commit comments

Comments
 (0)