olexsmir/gopher.nvim
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

chore: update CONTRIBUTING

Browse source
This commit is contained in:
Oleksandr Smirnov 2025-08-30 16:09:17 +03:00
parent 5a0f978586
commit 81ea7547e5
No known key found for this signature in database
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -25,11 +25,15 @@ task lint
### Documentation ### Documentation
Here we're using [mini.doc](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-doc.md) Here we're using [mini.doc](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-doc.md)
for generating help files based on [LuaCats](https://luals.github.io/wiki/annotations/) annotations in comments. for generating vimhelp files based on [LuaCats](https://luals.github.io/wiki/annotations/) annotations in comments.
For demo gifs in [readme](./README.md) we're using [vhs](https://github.com/charmbracelet/vhs).
All files related to demos live in [/vhs](./vhs) dir.
You can generate docs with: You can generate docs with:
```bash ```bash
task docgen task docgen # generates vimhelp
task vhs:generate # generates demo gifs
``` ```
### Commit messages ### Commit messages