tomas.mirchev/nvim-tree.lua
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: rename and simplify help update script

Browse Source
This commit is contained in:
Alexander Courtis 2022-06-20 11:54:14 +10:00
parent 6548287e8b
commit 104292c8f9
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -15,11 +15,11 @@ cargo install stylua
## Adding new actions ## Adding new actions
To add a new action, add a file in `actions/name-of-the-action.lua`. You should export a `setup` function if some configuration is needed. To add a new action, add a file in `actions/name-of-the-action.lua`. You should export a `setup` function if some configuration is needed.
Once you did, you should run the `scripts/update-default-opts.sh` which will update the default documentation in the README and the help file. Once you did, you should run the `scripts/update-help.sh`.
## Documentation ## Documentation
When adding new options, you should declare the defaults in the main `nvim-tree.lua` file. When adding new options, you should declare the defaults in the main `nvim-tree.lua` file.
Once you did, you should run the `scripts/update-default-opts.sh` which will update the default documentation in the README and the help file. Once you did, you should run the `scripts/update-help.sh`.
Documentation for options should also be added, see how this is done after `nvim-tree.disable_netrw` in the `nvim-tree-lua.txt` file. Documentation for options should also be added, see how this is done after `nvim-tree.disable_netrw` in the `nvim-tree-lua.txt` file.

0
scripts/update-default-opts.sh → scripts/update-help.sh
View File