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

docs: update CONTRIBUTING.md (#2485)

Browse Source
This commit is contained in:
Alexander Courtis 2023-10-21 13:54:25 +11:00 committed by GitHub
parent 40b9b887d0
commit 8b4dbc57e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -2,6 +2,8 @@
Thank you for contributing. Thank you for contributing.
See [Development](https://github.com/nvim-tree/nvim-tree.lua/wiki/Development) for environment setup, tips and tools.
## Styling and formatting ## Styling and formatting
Code is formatted using luacheck, and linted using stylua. Code is formatted using luacheck, and linted using stylua.
@ -24,7 +26,7 @@ Once you did, you should run the `scripts/update-help.sh`.
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-help.sh`. 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 to `nvim-tree-opts` in `doc/nvim-tree-lua.txt`
## Pull Request ## Pull Request