vim: CONTRIBUTING.md annotate

annotate CONTRIBUTING.md @ 14372:2a4a2dc35c55

Update runtime files. commit https://github.com/vim/vim/commit/a9604e61451707b38fdcb088fbfaeea2b922fef6 Author: Bram Moolenaar <Bram@vim.org> Date: Sat Jul 21 05:56:22 2018 +0200 Update runtime files.

author	Christian Brabandt <cb@256bit.org>
date	Sat, 21 Jul 2018 06:00:09 +0200
parents	723487cd7876
children	a23c883685cb

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<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 723487cd7876 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 7084 diff changeset	54 If the maintainer does not respond, contact the vim-dev maillist.
723487cd7876 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 7084 diff changeset	55
723487cd7876 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 7084 diff changeset	56
723487cd7876 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 7084 diff changeset	57 # Translations
723487cd7876 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 7084 diff changeset	58
723487cd7876 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 7084 diff changeset	59 Translating messages and runtime files is very much appreciated! These things can be translated:
14372 2a4a2dc35c55 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14347 diff changeset	60 * Messages in Vim, see [src/po/README.txt][1]
2a4a2dc35c55 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14347 diff changeset	61 * Menus, see [runtime/lang/README.txt][2]
2a4a2dc35c55 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14347 diff changeset	62 * Vim tutor, see [runtime/tutor/README.txt][3]
2a4a2dc35c55 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14347 diff changeset	63 * Manual pages, see [runtime/doc/\*.1][4] for examples
2a4a2dc35c55 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14347 diff changeset	64 * Desktop icon, see [runtime/vim.desktop][5] and [runtime/gvim.desktop][6]
14347 723487cd7876 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 7084 diff changeset	65
723487cd7876 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 7084 diff changeset	66 The help files can be translated and made available separately.
723487cd7876 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 7084 diff changeset	67 See https://www.vim.org/translations.php for examples.
14372 2a4a2dc35c55 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14347 diff changeset	68
2a4a2dc35c55 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14347 diff changeset	69 [1]: https://github.com/vim/vim/blob/master/src/po/README.txt
2a4a2dc35c55 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14347 diff changeset	70 [2]: https://github.com/vim/vim/blob/master/runtime/lang/README.txt
2a4a2dc35c55 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14347 diff changeset	71 [3]: https://github.com/vim/vim/blob/master/runtime/tutor/README.txt
2a4a2dc35c55 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14347 diff changeset	72 [4]: https://github.com/vim/vim/blob/master/runtime/doc/vim.1
2a4a2dc35c55 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14347 diff changeset	73 [5]: https://github.com/vim/vim/blob/master/runtime/vim.desktop
2a4a2dc35c55 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14347 diff changeset	74 [6]: https://github.com/vim/vim/blob/master/runtime/gvim.desktop

Mercurial > vim

annotate CONTRIBUTING.md @ 14372:2a4a2dc35c55