You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+20-7Lines changed: 20 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -121,19 +121,32 @@ else
121
121
end
122
122
```
123
123
124
-
# Adding New Actions
124
+
# Documentation
125
125
126
-
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.
126
+
## Config And Mappings
127
127
128
-
Once you did, you should run `make help-update`
128
+
When adding to or changing:
129
+
1.`DEFAULT_OPTS`
130
+
2.`Config` classes
131
+
3.`on_attach` default mappings
129
132
130
-
# Documentation
133
+
You must generate help documentation. This requires neovim stable sources. You will be promted with instructions on fetching and referencing the source.
131
134
132
-
## Opts
135
+
```sh
136
+
make help-update
137
+
```
133
138
134
-
When adding new options, you should declare the defaults in the main `nvim-tree.lua` file.
139
+
This will:
140
+
1. Update config defaults in `*nvim-tree-setup*`
141
+
2. Regenerate from `*nvim-tree-config*` to the end of the file, see `gen_vimdoc.sh`
142
+
3. Update default mappings in `*nvim-tree-mappings-default*` and `*nvim-tree-quickstart-help*`
143
+
144
+
Commit your changes then run:
145
+
```sh
146
+
make help-check
147
+
```
135
148
136
-
Documentation for options should also be added to `nvim-tree-opts` in `doc/nvim-tree-lua.txt`
149
+
This will re-run `help-update` and check that there are no diffs. It will also lint the documentation, see `lintdoc.sh`
0 commit comments