|
| 1 | +# Contributing To My Vim Plugins |
| 2 | + |
| 3 | +I'm not a Vim wizard by any means, nor am I too proud to accept |
| 4 | +contributions that improve my code, so if you think you have a problem, |
| 5 | +improvement, or other contribution towards the betterment of Vim-kind, |
| 6 | +please file an issue or, where appropriate, a pull request. |
| 7 | + |
| 8 | +When filing an issue, please explain exactly what's wrong in as much |
| 9 | +detail as you can, and try not to insult me in doing so. "It doesn't |
| 10 | +work, fix it" or "It doesn't work, you're an idiot" are not helpful |
| 11 | +issues. "I try to do this, I expect this, but I get that" or "I think you |
| 12 | +missed a step here in line 32" are better. Keep in mind that I'm not |
| 13 | +paid to write Vim plugins, so I'm doing this in my spare time, which |
| 14 | +means it might take me a while to respond. If you're not satisfied with |
| 15 | +my response to your problem with my free (as in beer and in speech) |
| 16 | +software, I will give you triple your $0.00 back. |
| 17 | + |
| 18 | +When filing a pull request, please explain what you're changing and why. |
| 19 | +Please limit your changes to the specific thing you're fixing; it's |
| 20 | +probably easiest for both of us if you isolate your change in a topic |
| 21 | +branch that I can merge without pulling in other stuff. Please do not |
| 22 | +update CHANGELOG, versions, etc.; I'll take care of that. I'll also add |
| 23 | +you to the Credits list with my thanks. |
| 24 | + |
| 25 | +All of my Vim plugins use the MIT license. If you submit a pull request, |
| 26 | +I'll assume you are OK with any code you add being placed under that |
| 27 | +same MIT license. If this is not the case for any reason, please let me |
| 28 | +know why you can't tolerate the MIT license. I am 99.99% likely to |
| 29 | +reject your change in that case, but I'll let you have your say. |
| 30 | + |
| 31 | +Thanks for contributing! |
0 commit comments