m-vim_plugins/vim-fugitive
1
0
Fork 0
mirror of https://github.com/tpope/vim-fugitive.git synced 2025-11-11 04:53:45 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Extract contribution guidelines

Browse Source
This commit is contained in:
Tim Pope
2013-04-23 19:39:45 -04:00
parent 5f7a8a9935
commit 25bbb3c5f5
2 changed files with 18 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.markdown Normal file
View File

@@ -0,0 +1,18 @@
Before reporting a bug, you should try stripping down your Vim configuration
and removing other plugins. The sad truth about VimScript is that it is
fraught with incompatibilities waiting to happen. I'm happy to work around
them where I can, but it's up to you to isolate the conflict.
If your [commit message sucks](http://stopwritingramblingcommitmessages.com/),
I'm not going to accept your pull request. I've explained very politely
dozens of times that
[my general guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
are absolute rules on my own repositories, so I may lack the energy to explain
it to you yet another time. And please, if I ask you to change something,
`git commit --amend`.
Beyond that, don't be shy about asking before patching. What takes you hours
might take me minutes simply because I have both domain knowledge and a
perverse knowledge of VimScript so vast that many would consider it a symptom
of mental illness. On the flip side, some ideas I'll reject no matter how
good the implementation is. "Send a patch" is an edge case answer in my book.

23
README.markdown
View File

@@ -105,29 +105,6 @@ to open after any grep invocation:
autocmd QuickFixCmdPost *grep* cwindow autocmd QuickFixCmdPost *grep* cwindow
## Contributing
Before reporting a bug, you should try stripping down your Vim
configuration and removing other plugins. The sad nature of VimScript
is that it is fraught with incompatibilities waiting to happen. I'm
happy to work around them where I can, but it's up to you to isolate
the conflict.
If your [commit message sucks](http://stopwritingramblingcommitmessages.com/),
I'm not going to accept your pull request. I've explained very politely
dozens of times that
[my general guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
are absolute rules on my own repositories, so I may lack the energy to
explain it to you yet another time. And please, if I ask you to change
something, `git commit --amend`.
Beyond that, don't be shy about asking before patching. What takes you
hours might take me minutes simply because I have both domain knowledge
and a perverse knowledge of VimScript so vast that many would consider
it a symptom of mental illness. On the flip side, some ideas I'll
reject no matter how good the implementation is. "Send a patch" is an
edge case answer in my book.
## Self-Promotion ## Self-Promotion
Like fugitive.vim? Follow the repository on Like fugitive.vim? Follow the repository on