]> granicus.if.org Git - vim/commitdiff
patch 7.4.846 v7.4.846
authorBram Moolenaar <Bram@vim.org>
Tue, 1 Sep 2015 15:50:48 +0000 (17:50 +0200)
committerBram Moolenaar <Bram@vim.org>
Tue, 1 Sep 2015 15:50:48 +0000 (17:50 +0200)
Problem:    Some GitHub users don't know how to use issues.
Solution:   Add a file that explains the basics of contributing.

CONTRIBUTING.md [new file with mode: 0644]
Filelist
src/version.c

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..8fb88c7
--- /dev/null
@@ -0,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.
+
+You can find known issues in the todo file: ":help todo".
+Or open [the todo file] on GitHub to see the latest version.
+
+[the todo file]: https://github.com/vim/vim/blob/master/runtime/doc/todo.txt
index 1dc7fd052697f5c04b1d8ebcb1fb5b0a8a721c37..166e2f4fa62c96c9dd350d9b6443a76214c1eadd 100644 (file)
--- a/Filelist
+++ b/Filelist
@@ -482,6 +482,7 @@ SRC_EXTRA = \
 RT_ALL =       \
                README.txt \
                README.md \
+               CONTRIBUTING.md \
                runtime/bugreport.vim \
                runtime/doc/*.awk \
                runtime/doc/*.pl \
index 7e464a58f4b8cbc25ccf7a084d5ccd6cf2f6d227..f6ec16aa972e0e46b74cd6d04c9e9428ce43696b 100644 (file)
@@ -741,6 +741,8 @@ static char *(features[]) =
 
 static int included_patches[] =
 {   /* Add new patch number below this line */
+/**/
+    846,
 /**/
     845,
 /**/