Skip to content

Commit 5effc6f

Browse files
docs(#457): add issue templates, notes on adding new icons (#551)
* docs: update contribution / icon adding docs * add issue templates * use type instead of label * fixup! docs: update contribution / icon adding docs * revert CONTRIBUTING as changes present in #550 * add missing icon notice * add contributing reference --------- Co-authored-by: hasecilu <hasecilu@tuta.io>
1 parent 4b0d255 commit 5effc6f

File tree

3 files changed

+94
-0
lines changed

3 files changed

+94
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Bug report
2+
description: Report a problem
3+
type: bug
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Before reporting:
9+
* search [existing issues](https://github.com/nvim-tree/nvim-web-devicons/issues)
10+
* ensure that nvim-web-devicons is updated to the latest version
11+
12+
Please submit a Pull Request to add an icon, see [CONTRIBUTING.md](https://github.com/nvim-tree/nvim-web-devicons/blob/master/CONTRIBUTING.md)
13+
- type: textarea
14+
attributes:
15+
label: "Description"
16+
description: "A short description of the problem you are reporting."
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: "Neovim version"
22+
description: "Output of `nvim --version`"
23+
placeholder: |
24+
NVIM v0.10.3
25+
Build type: RelWithDebInfo
26+
LuaJIT 2.1.1731601260
27+
render: text
28+
validations:
29+
required: true
30+
- type: input
31+
attributes:
32+
label: "nvim-web-devicons version"
33+
description: "`cd <your-package-directory>/nvim-web-devicons.lua ; git log --format='%h' -n 1`"
34+
placeholder: |
35+
commit hash
36+
validations:
37+
required: true
38+
- type: input
39+
attributes:
40+
label: "Operating system and version"
41+
placeholder: "Linux 5.16.11-arch1-1, macOS 11.5, Windows 10"
42+
validations:
43+
required: true
44+
- type: input
45+
attributes:
46+
label: "Windows variant"
47+
placeholder: "WSL, PowerShell, cygwin, msys"
48+
validations:
49+
required: false
50+
- type: textarea
51+
attributes:
52+
label: "Expected behavior"
53+
description: "A description of the behavior you expected:"
54+
- type: textarea
55+
attributes:
56+
label: "Actual behavior"
57+
description: "Observed behavior (may optionally include images, videos or a screencast)."
58+
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for nvim-web-devicons
4+
title: ''
5+
type: enhancement
6+
assignees: ''
7+
8+
---
9+
**Is this a request for a new icon?**
10+
Please submit a Pull Request to add an icon, see [CONTRIBUTING.md](https://github.com/nvim-tree/nvim-web-devicons/blob/master/CONTRIBUTING.md)
11+
12+
**Is your feature request related to a problem? Please describe.**
13+
A clear and concise description of what the problem is.
14+
15+
**Describe the solution you'd like**
16+
A clear and concise description of what you want to happen.
17+
18+
**Describe alternatives you've considered**
19+
A clear and concise description of any alternative solutions or features you've considered.
20+
21+
**Additional context**
22+
Add any other context or screenshots about the feature request here.

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,20 @@ or with [lazy.nvim](https://github.com/folke/lazy.nvim)
4444

4545
[![LuaRocks](https://img.shields.io/luarocks/v/nvim-tree/nvim-web-devicons?logo=lua&color=purple)](https://luarocks.org/modules/nvim-tree/nvim-web-devicons)
4646

47+
## Additional Icons
48+
49+
Additional icons may be added for icons that are present in Nerd Fonts: use the [Cheat Sheet](https://www.nerdfonts.com/cheat-sheet) search for available icons.
50+
51+
PRs are always welcome! Please see [CONTRIBUTING](CONTRIBUTING.md)
52+
53+
> [!IMPORTANT]
54+
> If the icon you need is not available on Nerd Fonts you first need to make a
55+
> PR to a project that feeds glyphs to Nerd Fonts. Probably the most adequate
56+
> project to contribute is <https://github.com/devicons/devicon>.
57+
> Take into account that **months** can pass before the icon is available on the
58+
> Nerd Fonts project, once there feel free to open a PR on this project, see
59+
> [CONTRIBUTING](CONTRIBUTING.md)
60+
4761
## Usage
4862

4963
### Viewing

0 commit comments

Comments
 (0)