Mercurial > vim

annotate CONTRIBUTING.md @ 7480:a49163681559 v7.4.1042

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e Author: Bram Moolenaar <Bram@vim.org> Date: Sun Jan 3 22:49:16 2016 +0100 patch 7.4.1042 Problem: g-CTRL-G shows the word count, but there is no way to get the word count in a script. Solution: Add the wordcount() function. (Christian Brabandt)
author Christian Brabandt <cb@256bit.org>
date Sun, 03 Jan 2016 23:00:04 +0100
parents 1c039023af1c
children 723487cd7876
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
a55f35ed381b commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff changeset
24 maillist. Try reproducing the problem without any plugins or settings:
a55f35ed381b commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff changeset
25
a55f35ed381b commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Christian Brabandt <cb@256bit.org>
parents:
diff changeset
26 vim -N -u NONE
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&lt;Esc&gt;".
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
1c039023af1c commit https://github.com/vim/vim/commit/b58988b832b69b52dfefeca338ea4802d0c4cdca
Christian Brabandt <cb@256bit.org>
parents: 7076
diff changeset
54 If the maintainer does not react, contact the vim-dev maillist.