16017f379SBram Moolenaar# Contributing to Vim 26017f379SBram Moolenaar 36017f379SBram MoolenaarPatches are welcome in whatever form. 46017f379SBram MoolenaarDiscussions about patches happen on the vim-dev maillist. 56017f379SBram MoolenaarIf you create a pull request on GitHub it will be 66017f379SBram Moolenaarforwarded to the vim-dev maillist. You can also send your patch there 76f33b893SBram Moolenaardirectly. In that case an attachment with a unified diff format is preferred. 86017f379SBram MoolenaarInformation about the maillist can be found [on the Vim website]. 96017f379SBram Moolenaar 106017f379SBram Moolenaar[on the Vim website]: http://www.vim.org/maillist.php#vim-dev 116017f379SBram Moolenaar 126f33b893SBram MoolenaarA pull request has the advantage that it will trigger the Continuous 136f33b893SBram MoolenaarIntegration tests, you will be warned of problems (you can ignore the coverage 146f33b893SBram Moolenaarwarning, it's noisy). 156f33b893SBram Moolenaar 166f33b893SBram MoolenaarPlease consider adding a test. All new functionality should be tested and bug 176f33b893SBram Moolenaarfixes should be tested for regressions: the test should fail before the fix and 186f33b893SBram Moolenaarpass after the fix. Look through recent patches for examples and find help 196f33b893SBram Moolenaarwith ":help testing". The tests are located under "src/testdir". 206f33b893SBram Moolenaar 216f33b893SBram MoolenaarContributions will be distributed with Vim under the Vim license. Providing a 226f33b893SBram Moolenaarchange to be included implies that you agree with this and your contribution 236f33b893SBram Moolenaardoes not cause us trouble with trademarks or patents. There is no CLA to sign. 246017f379SBram Moolenaar 256017f379SBram Moolenaar 266017f379SBram Moolenaar# Reporting issues 276017f379SBram Moolenaar 286017f379SBram MoolenaarWe use GitHub issues, but that is not a requirement. Writing to the Vim 296017f379SBram Moolenaarmaillist is also fine. 306017f379SBram Moolenaar 316017f379SBram MoolenaarPlease use the GitHub issues only for actual issues. If you are not 100% sure 326017f379SBram Moolenaarthat your problem is a Vim issue, please first discuss this on the Vim user 33723dd946SBram Moolenaarmaillist. Try reproducing the problem without any of your plugins or settings: 346017f379SBram Moolenaar 35723dd946SBram Moolenaar vim --clean 366017f379SBram Moolenaar 376017f379SBram MoolenaarIf you report an issue, please describe exactly how to reproduce it. 386017f379SBram MoolenaarFor example, don't say "insert some text" but say what you did exactly: 3954478024SBram Moolenaar"ahere is some text<Esc>". 4054478024SBram MoolenaarIdeally, the steps you list can be used to write a test to verify the problem 4154478024SBram Moolenaaris fixed. 426017f379SBram Moolenaar 436017f379SBram MoolenaarFeel free to report even the smallest problem, also typos in the documentation. 446017f379SBram Moolenaar 456017f379SBram MoolenaarYou can find known issues in the todo file: ":help todo". 466017f379SBram MoolenaarOr open [the todo file] on GitHub to see the latest version. 476017f379SBram Moolenaar 486017f379SBram Moolenaar[the todo file]: https://github.com/vim/vim/blob/master/runtime/doc/todo.txt 49b58988b8SBram Moolenaar 50b58988b8SBram Moolenaar 51b58988b8SBram Moolenaar# Syntax, indent and other runtime files 52b58988b8SBram Moolenaar 53b58988b8SBram MoolenaarThe latest version of these files can be obtained from the repository. 54b58988b8SBram MoolenaarThey are usually not updated with numbered patches. 55b58988b8SBram Moolenaar 56b58988b8SBram MoolenaarIf you find a problem with one of these files or have a suggestion for 57b58988b8SBram Moolenaarimprovement, please first try to contact the maintainer directly. 58b58988b8SBram MoolenaarLook in the header of the file for the name and email address. 59b58988b8SBram Moolenaar 60b58988b8SBram MoolenaarThe maintainer will take care of issues and send updates to Bram for 61b58988b8SBram Moolenaardistribution with Vim. 62b58988b8SBram Moolenaar 63b477af22SBram MoolenaarIf the maintainer does not respond, contact the vim-dev maillist. 64b477af22SBram Moolenaar 65b477af22SBram Moolenaar 66b477af22SBram Moolenaar# Translations 67b477af22SBram Moolenaar 68*403f3eb4SBram MoolenaarTranslations of this CONTRIBUTING file: 69*403f3eb4SBram Moolenaar[Korean](https://github.com/cjw1359/opensource/blob/master/Vim/CONTRIBUTING_ko.md) 70*403f3eb4SBram Moolenaar 71a60e536aSBram MoolenaarTranslating messages and runtime files is very much appreciated! These things 72a60e536aSBram Moolenaarcan be translated: 73a9604e61SBram Moolenaar* Messages in Vim, see [src/po/README.txt][1] 74a60e536aSBram Moolenaar Also used for the desktop icons. 75a9604e61SBram Moolenaar* Menus, see [runtime/lang/README.txt][2] 76a9604e61SBram Moolenaar* Vim tutor, see [runtime/tutor/README.txt][3] 77a9604e61SBram Moolenaar* Manual pages, see [runtime/doc/\*.1][4] for examples 78a60e536aSBram Moolenaar* Installer, see [nsis/lang/\*.nsi][5] for examples 79b477af22SBram Moolenaar 80b477af22SBram MoolenaarThe help files can be translated and made available separately. 81b477af22SBram MoolenaarSee https://www.vim.org/translations.php for examples. 82a9604e61SBram Moolenaar 83a9604e61SBram Moolenaar[1]: https://github.com/vim/vim/blob/master/src/po/README.txt 84a9604e61SBram Moolenaar[2]: https://github.com/vim/vim/blob/master/runtime/lang/README.txt 85a9604e61SBram Moolenaar[3]: https://github.com/vim/vim/blob/master/runtime/tutor/README.txt 86a9604e61SBram Moolenaar[4]: https://github.com/vim/vim/blob/master/runtime/doc/vim.1 87a60e536aSBram Moolenaar[5]: https://github.com/vim/vim/blob/master/nsis/lang/english.nsi 88