Mercurial > vim
comparison CONTRIBUTING.md @ 7068:a55f35ed381b v7.4.846
commit https://github.com/vim/vim/commit/6017f3799dbb744fc34894d968b36729e607203e
Author: Bram Moolenaar <Bram@vim.org>
Date: Tue Sep 1 17:50:48 2015 +0200
patch 7.4.846
Problem: Some GitHub users don't know how to use issues.
Solution: Add a file that explains the basics of contributing.
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Tue, 01 Sep 2015 18:00:05 +0200 |
| parents | |
| children | 6ad58a7e995b |
comparison
equal
deleted
inserted
replaced
| 7067:61f1358f6355 | 7068:a55f35ed381b |
|---|---|
| 1 # Contributing to Vim | |
| 2 | |
| 3 Patches are welcome in whatever form. | |
| 4 Discussions about patches happen on the vim-dev maillist. | |
| 5 If you create a pull request on GitHub it will be | |
| 6 forwarded to the vim-dev maillist. You can also send your patch there | |
| 7 directly. An attachment with a unified diff format is preferred. | |
| 8 Information about the maillist can be found [on the Vim website]. | |
| 9 | |
| 10 [on the Vim website]: http://www.vim.org/maillist.php#vim-dev | |
| 11 | |
| 12 Please consider adding a test. Test coverage isn't very good yet, this needs | |
| 13 to improve. Look through recent patches for examples. The tests are located | |
| 14 under "src/testdir". | |
| 15 | |
| 16 | |
| 17 # Reporting issues | |
| 18 | |
| 19 We use GitHub issues, but that is not a requirement. Writing to the Vim | |
| 20 maillist is also fine. | |
| 21 | |
| 22 Please use the GitHub issues only for actual issues. If you are not 100% sure | |
| 23 that your problem is a Vim issue, please first discuss this on the Vim user | |
| 24 maillist. Try reproducing the problem without any plugins or settings: | |
| 25 | |
| 26 vim -N -u NONE | |
| 27 | |
| 28 If you report an issue, please describe exactly how to reproduce it. | |
| 29 For example, don't say "insert some text" but say what you did exactly: | |
| 30 "ahere is some text<Esc>". Ideally, the steps you list can be used to write a | |
| 31 test to verify the problem is fixed. | |
| 32 | |
| 33 Feel free to report even the smallest problem, also typos in the documentation. | |
| 34 | |
| 35 You can find known issues in the todo file: ":help todo". | |
| 36 Or open [the todo file] on GitHub to see the latest version. | |
| 37 | |
| 38 [the todo file]: https://github.com/vim/vim/blob/master/runtime/doc/todo.txt |