# HG changeset patch
# User Ludovic Chabant <ludovic@chabant.com>
# Date 1487566070 28800
# Node ID 02a94ff0db5771ac410577a7a6a6a761d6d23a60
# Parent  18df731b1563c820fd2623e28f84203242579b53
Add CONTRIBUTING file.

diff -r 18df731b1563 -r 02a94ff0db57 CONTRIBUTING.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/CONTRIBUTING.md	Sun Feb 19 20:47:50 2017 -0800
@@ -0,0 +1,60 @@
+
+# Contributing
+
+You're thinking of contributing something to one of my projects? Oh my, I'm
+quite honoured! Here's what you need to know.
+
+
+## Writing
+
+Clone the repository from either [BitBucket][] (if you're into Mercurial) or
+[GitHub][] (if you're into Git).
+
+Next, create a branch for your work -- don't work directly on the `defaut` or
+`master` branch. Instead, in Mercurial:
+
+  $ hg bookmark my-fix
+
+Or, in Git:
+
+  $ git checkout -b my-fix master
+
+Make your changes. Don't write anything that's not related to the fix you're
+trying to contribute to the project.
+
+Write a simple, concise commit message. Gutentags isn't a big piece of code so
+no need for strict message formats, so don't get fancy.
+
+
+## Testing
+
+If you can, try and test your changes on multiple platforms -- Ubuntu, MacOS,
+and Windows are supposed to be supported.
+
+Also try to test your changes with:
+
+1. `g:gutentags_cache_dir` enabled and disabled.
+2. A repository with spaces in its root path.
+3. A repository with files and folders that have spaces in them.
+
+If you're on NeoVim, try and test on a "normal" Vim.
+
+
+## Pushing
+
+Once everything's fine, go on BitBucket or GitHub (again, depending on your
+favorite source control tool) and create a fork if you haven't done so yet. Push
+your changes to your fork, and create a pull request. Check the documentation of
+either code portal for more information.
+
+Don't worry if you don't see any reply from me for a while. My turn around time
+is measured in weeks, sometimes in months. This is normal -- I've got a job,
+a family, and open-source hacking is only one of many awesome hobbies I spend my
+limited free time on.
+
+That's it for now! And thanks a lot for contributing!
+
+
+[bitbucket]: https://bitbucket.org/ludovicchabant/vim-gutentags
+[github]: https://github.com/ludovicchabant/vim-gutentags
+
diff -r 18df731b1563 -r 02a94ff0db57 README.md
--- a/README.md	Sun Feb 19 20:12:01 2017 -0800
+++ b/README.md	Sun Feb 19 20:47:50 2017 -0800
@@ -6,6 +6,7 @@
 completely out of your way. It will even do its best to keep those tag files
 out of your way too. It has no dependencies and just works.
 
+
 ## How?
 
 Install Gutentags like any other Vim plugin. I recommend something like
@@ -49,11 +50,11 @@
 I set for myself with Gutentags:
 
 * No other dependency than running Vim: no Python, Ruby, or whatever.
-* Cross-platform: should work on at least Mac and Windows.
+* Cross-platform: should work on at least Ubuntu, Mac, and Windows.
 * Incremental tags generation: don't re-generate the whole project all the time.
   This may be fine for small projects, but it doesn't scale.
 * External process management: if the ctags process is taking a long time, don't
-  run another one because I saved the file again.
+  run another one because I saved a file again.
 * Keep the tag file consistent: don't just append the current file's tags to the
   tag file, otherwise you will still "see" tags for deleted or renamed classes
   and functions.