Skip to content

Commit bc51ec5

Browse files
committed
runtime(doc): Update CONTRIBUTING and clarify use of Vim9 script
related: #17871 Signed-off-by: Christian Brabandt <cb@256bit.org>
1 parent 761ea77 commit bc51ec5

1 file changed

Lines changed: 19 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ approvers are happy with that particular change.
4848

4949
# Reporting issues
5050

51-
We use GitHub issues, but that is not a requirement. Writing to the Vim
51+
We use GitHub [issues][17], but that is not a requirement. Writing to the Vim
5252
mailing list is also fine.
5353

5454
Please use the GitHub issues only for actual issues. If you are not 100% sure
@@ -72,7 +72,8 @@ Or open [the todo file][todo list] on GitHub to see the latest version.
7272

7373
The latest version of these files can be obtained from the repository.
7474
They are usually not updated with numbered patches. However, they may
75-
or may not work with older Vim releases (since they may contain new features).
75+
or may not work with older Vim releases (since they may depend on new
76+
features).
7677

7778
If you find a problem with one of these files or have a suggestion for
7879
improvement, please first try to contact the maintainer directly.
@@ -82,7 +83,18 @@ upstream repository. You may also check the [MAINTAINERS][11] file.
8283
The maintainer will take care of issues and send updates to the Vim project for
8384
distribution with Vim.
8485

85-
If the maintainer does not respond, contact the [vim-dev][0] mailing list.
86+
If the maintainer does not respond, contact the [vim-dev][0] mailing list or
87+
open an [issue][17] here.
88+
89+
Note: Whether or not to use Vim9 script is up to the maintainer. For runtime
90+
files maintained here, we aim to preserve compatibility with Neovim if
91+
possible. Please wrap Vim9 script with a guard like this:
92+
```vim
93+
if has('vim9script')
94+
" use Vim9 script implementation
95+
[...]
96+
endif
97+
```
8698

8799
## Contributing new runtime files
88100

@@ -95,6 +107,9 @@ PR with your changes against this repository here. For new filetypes, do not for
95107
- add yourself as Maintainer to the top of file (again, keep the header similar to
96108
other runtime files)
97109
- add yourself to the [MAINTAINERS][11] file.
110+
- add a guard `if has('vim9script')` if you like to maintain Neovim
111+
compatibility but want to use Vim9 script (or restrict yourself to legacy Vim
112+
script)
98113

99114
# Translations
100115

@@ -144,3 +159,4 @@ mailing list. For other questions please use the [Vi Stack Exchange][8] website,
144159
[14]: https://github.com/vim/vim/blob/master/runtime/doc/syntax.txt
145160
[15]: https://en.wikipedia.org/wiki/Developer_Certificate_of_Origin
146161
[16]: https://github.com/vim/vim/blob/master/runtime/doc/helphelp.txt
162+
[17]: https://github.com/vim/vim/issues

0 commit comments

Comments
 (0)