Mercurial > vim
annotate CONTRIBUTING.md @ 17346:72ce5ca82a75 v8.1.1672
patch 8.1.1672: "make cmdidxs" doesn't work
commit https://github.com/vim/vim/commit/d94ac0caca12c6ceb54b07fc932edba84a5f60f2
Author: Bram Moolenaar <Bram@vim.org>
Date: Fri Jul 12 20:24:59 2019 +0200
patch 8.1.1672: "make cmdidxs" doesn't work
Problem: "make cmdidxs" doesn't work.
Solution: Update macro names. (Naruhiko Nishino, closes https://github.com/vim/vim/issues/4660)
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Fri, 12 Jul 2019 20:30:06 +0200 |
parents | e71261a88630 |
children | c12c811695f7 |
rev | line source |
---|---|
7068
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
1 # Contributing to Vim |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
2 |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
3 Patches are welcome in whatever form. |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
4 Discussions about patches happen on the vim-dev maillist. |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
5 If you create a pull request on GitHub it will be |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
6 forwarded to the vim-dev maillist. You can also send your patch there |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
7 directly. An attachment with a unified diff format is preferred. |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
8 Information about the maillist can be found [on the Vim website]. |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
9 |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
10 [on the Vim website]: http://www.vim.org/maillist.php#vim-dev |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
11 |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
12 Please consider adding a test. Test coverage isn't very good yet, this needs |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
13 to improve. Look through recent patches for examples. The tests are located |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
14 under "src/testdir". |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
15 |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
16 |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
17 # Reporting issues |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
18 |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
19 We use GitHub issues, but that is not a requirement. Writing to the Vim |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
20 maillist is also fine. |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
21 |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
22 Please use the GitHub issues only for actual issues. If you are not 100% sure |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
23 that your problem is a Vim issue, please first discuss this on the Vim user |
16208 | 24 maillist. Try reproducing the problem without any of your plugins or settings: |
7068
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
25 |
16208 | 26 vim --clean |
7068
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
27 |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
28 If you report an issue, please describe exactly how to reproduce it. |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
29 For example, don't say "insert some text" but say what you did exactly: |
7076
6ad58a7e995b
commit https://github.com/vim/vim/commit/544780248b5876339b316703fc2f330a9d316c45
Christian Brabandt <cb@256bit.org>
parents:
7068
diff
changeset
|
30 "ahere is some text<Esc>". |
6ad58a7e995b
commit https://github.com/vim/vim/commit/544780248b5876339b316703fc2f330a9d316c45
Christian Brabandt <cb@256bit.org>
parents:
7068
diff
changeset
|
31 Ideally, the steps you list can be used to write a test to verify the problem |
6ad58a7e995b
commit https://github.com/vim/vim/commit/544780248b5876339b316703fc2f330a9d316c45
Christian Brabandt <cb@256bit.org>
parents:
7068
diff
changeset
|
32 is fixed. |
7068
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
33 |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
34 Feel free to report even the smallest problem, also typos in the documentation. |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
35 |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
36 You can find known issues in the todo file: ":help todo". |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
37 Or open [the todo file] on GitHub to see the latest version. |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
38 |
a55f35ed381b
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff
changeset
|
39 [the todo file]: https://github.com/vim/vim/blob/master/runtime/doc/todo.txt |
7084
1c039023af1c
commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents:
7076
diff
changeset
|
40 |
1c039023af1c
commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents:
7076
diff
changeset
|
41 |
1c039023af1c
commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents:
7076
diff
changeset
|
42 # Syntax, indent and other runtime files |
1c039023af1c
commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents:
7076
diff
changeset
|
43 |
1c039023af1c
commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents:
7076
diff
changeset
|
44 The latest version of these files can be obtained from the repository. |
1c039023af1c
commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents:
7076
diff
changeset
|
45 They are usually not updated with numbered patches. |
1c039023af1c
commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents:
7076
diff
changeset
|
46 |
1c039023af1c
commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents:
7076
diff
changeset
|
47 If you find a problem with one of these files or have a suggestion for |
1c039023af1c
commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents:
7076
diff
changeset
|
48 improvement, please first try to contact the maintainer directly. |
1c039023af1c
commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents:
7076
diff
changeset
|
49 Look in the header of the file for the name and email address. |
1c039023af1c
commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents:
7076
diff
changeset
|
50 |
1c039023af1c
commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents:
7076
diff
changeset
|
51 The maintainer will take care of issues and send updates to Bram for |
1c039023af1c
commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents:
7076
diff
changeset
|
52 distribution with Vim. |
1c039023af1c
commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents:
7076
diff
changeset
|
53 |
14347 | 54 If the maintainer does not respond, contact the vim-dev maillist. |
55 | |
56 | |
57 # Translations | |
58 | |
16285
e71261a88630
patch 8.1.1147: desktop file translations are requiring manual updates
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
59 Translating messages and runtime files is very much appreciated! These things |
e71261a88630
patch 8.1.1147: desktop file translations are requiring manual updates
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
60 can be translated: |
14372 | 61 * Messages in Vim, see [src/po/README.txt][1] |
16285
e71261a88630
patch 8.1.1147: desktop file translations are requiring manual updates
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
62 Also used for the desktop icons. |
14372 | 63 * Menus, see [runtime/lang/README.txt][2] |
64 * Vim tutor, see [runtime/tutor/README.txt][3] | |
65 * Manual pages, see [runtime/doc/\*.1][4] for examples | |
16285
e71261a88630
patch 8.1.1147: desktop file translations are requiring manual updates
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
66 * Installer, see [nsis/lang/\*.nsi][5] for examples |
14347 | 67 |
68 The help files can be translated and made available separately. | |
69 See https://www.vim.org/translations.php for examples. | |
14372 | 70 |
71 [1]: https://github.com/vim/vim/blob/master/src/po/README.txt | |
72 [2]: https://github.com/vim/vim/blob/master/runtime/lang/README.txt | |
73 [3]: https://github.com/vim/vim/blob/master/runtime/tutor/README.txt | |
74 [4]: https://github.com/vim/vim/blob/master/runtime/doc/vim.1 | |
16285
e71261a88630
patch 8.1.1147: desktop file translations are requiring manual updates
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
75 [5]: https://github.com/vim/vim/blob/master/nsis/lang/english.nsi |