1# Contributing to Vim 2 3Patches are welcome in whatever form. 4Discussions about patches happen on the vim-dev maillist. 5If you create a pull request on GitHub it will be 6forwarded to the vim-dev maillist. You can also send your patch there 7directly. In that case an attachment with a unified diff format is preferred. 8Information 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 12A pull request has the advantage that it will trigger the Continuous 13Integration tests, you will be warned of problems (you can ignore the coverage 14warning, it's noisy). 15 16Please consider adding a test. All new functionality should be tested and bug 17fixes should be tested for regressions: the test should fail before the fix and 18pass after the fix. Look through recent patches for examples and find help 19with ":help testing". The tests are located under "src/testdir". 20 21Contributions will be distributed with Vim under the Vim license. Providing a 22change to be included implies that you agree with this and your contribution 23does not cause us trouble with trademarks or patents. There is no CLA to sign. 24 25 26# Reporting issues 27 28We use GitHub issues, but that is not a requirement. Writing to the Vim 29maillist is also fine. 30 31Please use the GitHub issues only for actual issues. If you are not 100% sure 32that your problem is a Vim issue, please first discuss this on the Vim user 33maillist. Try reproducing the problem without any of your plugins or settings: 34 35 vim --clean 36 37If you report an issue, please describe exactly how to reproduce it. 38For example, don't say "insert some text" but say what you did exactly: 39"ahere is some text<Esc>". 40Ideally, the steps you list can be used to write a test to verify the problem 41is fixed. 42 43Feel free to report even the smallest problem, also typos in the documentation. 44 45You can find known issues in the todo file: ":help todo". 46Or open [the todo file] on GitHub to see the latest version. 47 48[the todo file]: https://github.com/vim/vim/blob/master/runtime/doc/todo.txt 49 50 51# Syntax, indent and other runtime files 52 53The latest version of these files can be obtained from the repository. 54They are usually not updated with numbered patches. 55 56If you find a problem with one of these files or have a suggestion for 57improvement, please first try to contact the maintainer directly. 58Look in the header of the file for the name and email address. 59 60The maintainer will take care of issues and send updates to Bram for 61distribution with Vim. 62 63If the maintainer does not respond, contact the vim-dev maillist. 64 65 66# Translations 67 68Translations of this CONTRIBUTING file: 69[Korean](https://github.com/cjw1359/opensource/blob/master/Vim/CONTRIBUTING_ko.md) 70 71Translating messages and runtime files is very much appreciated! These things 72can be translated: 73* Messages in Vim, see [src/po/README.txt][1] 74 Also used for the desktop icons. 75* Menus, see [runtime/lang/README.txt][2] 76* Vim tutor, see [runtime/tutor/README.txt][3] 77* Manual pages, see [runtime/doc/\*.1][4] for examples 78* Installer, see [nsis/lang/\*.nsi][5] for examples 79 80The help files can be translated and made available separately. 81See https://www.vim.org/translations.php for examples. 82 83[1]: https://github.com/vim/vim/blob/master/src/po/README.txt 84[2]: https://github.com/vim/vim/blob/master/runtime/lang/README.txt 85[3]: https://github.com/vim/vim/blob/master/runtime/tutor/README.txt 86[4]: https://github.com/vim/vim/blob/master/runtime/doc/vim.1 87[5]: https://github.com/vim/vim/blob/master/nsis/lang/english.nsi 88