Hi Bram! On Di, 01 Sep 2015, Bram Moolenaar wrote:
> 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. > Files: Filelist, CONTRIBUTING.md > > > *** ../vim-7.4.845/Filelist 2015-07-10 19:21:45.663489149 +0200 > --- Filelist 2015-09-01 17:28:10.878424667 +0200 > *************** > *** 482,487 **** > --- 482,488 ---- > RT_ALL = \ > README.txt \ > README.md \ > + CONTRIBUTING.md \ > runtime/bugreport.vim \ > runtime/doc/*.awk \ > runtime/doc/*.pl \ > *** ../vim-7.4.845/CONTRIBUTING.md 2015-09-01 17:50:23.908582991 +0200 > --- CONTRIBUTING.md 2015-09-01 17:49:57.812854008 +0200 > *************** > *** 0 **** > --- 1,38 ---- > + # Contributing to Vim > + > + Patches are welcome in whatever form. > + Discussions about patches happen on the vim-dev maillist. > + If you create a pull request on GitHub it will be > + forwarded to the vim-dev maillist. You can also send your patch there > + directly. An attachment with a unified diff format is preferred. > + Information about the maillist can be found [on the Vim website]. > + > + [on the Vim website]: http://www.vim.org/maillist.php#vim-dev > + > + Please consider adding a test. Test coverage isn't very good yet, this > needs > + to improve. Look through recent patches for examples. The tests are > located > + under "src/testdir". > + > + > + # Reporting issues > + > + We use GitHub issues, but that is not a requirement. Writing to the Vim > + maillist is also fine. > + > + Please use the GitHub issues only for actual issues. If you are not 100% > sure > + that your problem is a Vim issue, please first discuss this on the Vim user > + maillist. Try reproducing the problem without any plugins or settings: > + > + vim -N -u NONE > + > + If you report an issue, please describe exactly how to reproduce it. > + For example, don't say "insert some text" but say what you did exactly: > + "ahere is some text<Esc>". Ideally, the steps you list can be used to > write a > + test to verify the problem is fixed. > + > + Feel free to report even the smallest problem, also typos in the > documentation. How about to add this paragraph: If you find a problem with the included runtime files (e.g. syntax files, filetype plugins or other included VimL files), please first try to contact the maintainer of that file (which is usually mentioned at the top of that particular file). The maintainer will take care of issues and send updates to Bram for distribution with Vim. If the maintainer does not react, contact the vim-dev mailinglist. Best, Christian -- Es gibt zwei friedliche Gewalten: Das Recht und die Schicklichkeit. -- Goethe, Maximen und Reflektionen, Nr. 93 -- -- You received this message from the "vim_dev" maillist. Do not top-post! Type your reply below the text you are replying to. For more information, visit http://www.vim.org/maillist.php --- You received this message because you are subscribed to the Google Groups "vim_dev" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/d/optout.
