| Bram Moolenaar | 6017f37 | 2015-09-01 17:50:48 +0200 | [diff] [blame] | 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: |
| Bram Moolenaar | 5447802 | 2015-09-01 19:50:09 +0200 | [diff] [blame] | 30 | "ahere is some text<Esc>". |
| 31 | Ideally, the steps you list can be used to write a test to verify the problem |
| 32 | is fixed. |
| Bram Moolenaar | 6017f37 | 2015-09-01 17:50:48 +0200 | [diff] [blame] | 33 | |
| 34 | Feel free to report even the smallest problem, also typos in the documentation. |
| 35 | |
| 36 | You can find known issues in the todo file: ":help todo". |
| 37 | Or open [the todo file] on GitHub to see the latest version. |
| 38 | |
| 39 | [the todo file]: https://github.com/vim/vim/blob/master/runtime/doc/todo.txt |
| Bram Moolenaar | b58988b | 2015-09-01 21:25:44 +0200 | [diff] [blame] | 40 | |
| 41 | |
| 42 | # Syntax, indent and other runtime files |
| 43 | |
| 44 | The latest version of these files can be obtained from the repository. |
| 45 | They are usually not updated with numbered patches. |
| 46 | |
| 47 | If you find a problem with one of these files or have a suggestion for |
| 48 | improvement, please first try to contact the maintainer directly. |
| 49 | Look in the header of the file for the name and email address. |
| 50 | |
| 51 | The maintainer will take care of issues and send updates to Bram for |
| 52 | distribution with Vim. |
| 53 | |
| 54 | If the maintainer does not react, contact the vim-dev maillist. |