forked from amix/vimrc
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
83 changed files
with
1,210 additions
and
500 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
[submodule "sources_non_forked/SingleCompile"] | ||
path = sources_non_forked/SingleCompile | ||
url = https://github.com/xuhdev/SingleCompile | ||
[submodule "sources_non_forked/Deliminate"] | ||
path = sources_non_forked/Deliminate | ||
url = https://github.com/Raimondi/delimitMate | ||
[submodule "sources_non_forked/ScrollColors"] | ||
path = sources_non_forked/ScrollColors | ||
url = https://github.com/Raimondi/delimitMate | ||
[submodule "sources_non_forked/vim-colorschemes"] | ||
path = sources_non_forked/vim-colorschemes | ||
url = https://github.com/flazz/vim-colorschemes.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,105 @@ | ||
# Bug reports / Github issues | ||
# CONTRIBUTING | ||
- - - | ||
1\. [Bug reports / GitHub issues](#bugreps) | ||
2\. [Submitting a patch](#patches) | ||
3\. [General style notes](#generalstyle) | ||
4\. [Syntax checker notes](#checkerstyle) | ||
- - - | ||
|
||
When reporting a bug make sure you search the existing github issues for the | ||
same/similar issues. If you find one, feel free to add a `+1` comment with any | ||
additional information that may help us solve the issue. | ||
<a name="bugreps"></a> | ||
|
||
## 1. Bug reports / GitHub issues | ||
|
||
Please note that the preferred channel for posting bug reports is the | ||
[issue tracker at GitHub][0]. Reports posted elsewhere are less likely | ||
to be seen by the core team. | ||
|
||
When reporting a bug make sure you search the existing GitHub issues | ||
for the same/similar issues. If you find one, feel free to add a `+1` | ||
comment with any additional information that may help us solve the | ||
issue. | ||
|
||
When creating a new issue be sure to state the following: | ||
|
||
* Steps to reproduce the bug. | ||
* The version of vim you are using. | ||
* The version of syntastic you are using. | ||
* steps to reproduce the bug; | ||
* the version of Vim you are using (run `:ver` to find out); | ||
* the version of syntastic you are using (see `:SyntasticInfo`). | ||
|
||
For syntax checker bugs also state the version of the checker executable | ||
that you are using. Adding debugging information is typically useful | ||
too: | ||
|
||
* open a file handled by your checker; | ||
* set `g:syntastic_debug` to 1 or 3; | ||
* run the checker; | ||
* copy the output of `:mes`. | ||
|
||
<a name="patches"></a> | ||
|
||
## 2. Submitting a patch | ||
|
||
For syntax checker bugs also state the version of the checker executable that you are using. | ||
Before you consider adding features to syntastic, _please_ spend a few | ||
minutes (re-)reading the latest version of the [manual][1]. Syntastic | ||
is changing rapidly at times, and it's quite possible that some of the | ||
features you want to add exist already. | ||
|
||
# Submitting a patch | ||
To submit a patch: | ||
|
||
* Fork the repo on github | ||
* Make a [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches#using-topic-branches-when-contributing-patches) and start hacking | ||
* Submit a pull request based off your topic branch | ||
* fork the [repo][2] on GitHub; | ||
* make a [topic branch][3] and start hacking; | ||
* submit a pull request based off your topic branch. | ||
|
||
Small focused patches are preferred. | ||
Small, focused patches are preferred. | ||
|
||
Large changes to the code should be discussed with the core team first. Create an issue and explain your plan and see what we say. | ||
Large changes to the code should be discussed with the core team first. | ||
Create an issue and explain your plan and see what we say. | ||
|
||
# General style notes | ||
Also make sure to update the manual whenever applicable. Nobody can use | ||
features that aren't documented. | ||
|
||
Following the coding conventions/styles used in the syntastic core: | ||
<a name="generalstyle"></a> | ||
|
||
* Use 4 space indents. | ||
* Don't use abbreviated keywords - e.g. use `endfunction`, not `endfun` (there's always room for more fun!). | ||
* Don't use `l:` prefixes for variables unless actually required (i.e. almost never). | ||
* Code for maintainability. We would rather a function be a couple of lines longer and have (for example) some [explaining variables](http://www.refactoring.com/catalog/extractVariable.html) to aid readability. | ||
## 3. General style notes | ||
|
||
# Syntax checker style notes | ||
Follow the coding conventions/styles used in the syntastic core: | ||
|
||
The preferred style for error format strings is one "clause" per line. E.g. | ||
(from the coffeelint checker): | ||
* use 4 space indents; | ||
* don't use abbreviated keywords - e.g. use `endfunction`, not `endfun` | ||
(there's always room for more fun!); | ||
* don't use `l:` prefixes for variables unless actually required (i.e. | ||
almost never); | ||
* code for maintainability; we would rather a function be a couple of | ||
lines longer and have (for example) some [explaining variables][4] to | ||
aid readability. | ||
|
||
```viml | ||
let errorformat = '%E%f:%l:%c: %trror: %m,' . | ||
\ 'Syntax%trror: In %f\, %m on line %l,' . | ||
\ '%EError: In %f\, Parse error on line %l: %m,' . | ||
\ '%EError: In %f\, %m on line %l,' . | ||
\ '%W%f(%l): lint warning: %m,' . | ||
\ '%W%f(%l): warning: %m,' . | ||
\ '%E%f(%l): SyntaxError: %m,' . | ||
\ '%-Z%p^,' . | ||
\ '%-G%.%#' | ||
<a name="checkerstyle"></a> | ||
|
||
## 4. Syntax checker notes | ||
|
||
Make sure to read the [guide][5] if you plan to add new syntax checkers. | ||
|
||
Use the existing checkers as templates, rather than writing everything | ||
from scratch. | ||
|
||
The preferred style for error format strings is one "clause" per line. | ||
E.g. (from the `coffee` checker): | ||
|
||
```vim | ||
let errorformat = | ||
\ '%E%f:%l:%c: %trror: %m,' . | ||
\ 'Syntax%trror: In %f\, %m on line %l,' . | ||
\ '%EError: In %f\, Parse error on line %l: %m,' . | ||
\ '%EError: In %f\, %m on line %l,' . | ||
\ '%W%f(%l): lint warning: %m,' . | ||
\ '%W%f(%l): warning: %m,' . | ||
\ '%E%f(%l): SyntaxError: %m,' . | ||
\ '%-Z%p^,' . | ||
\ '%-G%.%#' | ||
``` | ||
|
||
[0]: https://github.com/scrooloose/syntastic/issues | ||
[1]: https://github.com/scrooloose/syntastic/blob/master/doc/syntastic.txt | ||
[2]: https://github.com/scrooloose/syntastic | ||
[3]: https://github.com/dchelimsky/rspec/wiki/Topic-Branches#using-topic-branches-when-contributing-patches | ||
[4]: http://www.refactoring.com/catalog/extractVariable.html | ||
[5]: https://github.com/scrooloose/syntastic/wiki/Syntax-Checker-Guide |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.