Never :Gedit with a trailing slash
[vim-fugitive.git] / CONTRIBUTING.markdown
blobe651dcae873fc2af1e1186fce2679314f7c99143
1 Before reporting a bug, you should try stripping down your Vim configuration
2 and removing other plugins.  The sad truth about VimScript is that it is
3 fraught with incompatibilities waiting to happen.  I'm happy to work around
4 them where I can, but it's up to you to isolate the conflict.
6 Fugitive is particularly prone to regressions due to Git version issues,
7 platform issues, and interactions with other plugins.  I end up bisecting a
8 lot more than other projects, and thus I'm especially meticulous here about
9 maintaining a clean, readable, history.  Squash and force push any requested
10 changes to a pull request.  And if your [commit message
11 sucks](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
12 I'm not going to accept it.  Period.
14 Beyond that, don't be shy about asking before patching.  What takes you hours
15 might take me minutes simply because I have both domain knowledge and a
16 perverse knowledge of VimScript so vast that many would consider it a symptom
17 of mental illness.  On the flip side, some ideas I'll reject no matter how
18 good the implementation is.  "Send a patch" is an edge case answer in my book.