Skip to content

Commit 747f267

Browse files
committed
Add git-flow instructions for new commits
1 parent 7064a6e commit 747f267

File tree

1 file changed

+34
-18
lines changed

1 file changed

+34
-18
lines changed

README.markdown

Lines changed: 34 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,20 @@ This version of this file features the following text highlights:
1717
- Operation, comparison and logical symbols (`=`,`==`,`===`,`!=`,etc.).
1818
- Separate highlight of the arguments. Thanks to [Billychan](https://github.com/jelera/vim-javascript-syntax/commit/b03f40ff6ddf605ac146634a651632d6c1e8a50b).
1919

20-
To enable code folding add the following to your `.vimrc`.
2120

22-
```vim
23-
au FileType javascript call JavaScriptFold()
24-
```
21+
### [Screenshots](http://imgur.com/a/7bnu3)
22+
This is the stock Javascript syntax file
23+
#### Solarized Light
24+
![Stock Vim JavaScript syntax file](http://i.imgur.com/FCVLMgl.png)
2525

26+
This is with the Enhanced Syntax file
27+
![Enhanced JavaScript Vim syntax](http://i.imgur.com/yGY3Cmm.png)
28+
29+
#### Hybrid
30+
![Stock Vim JavaScript syntax file](http://i.imgur.com/cGb3EjH.png)
31+
32+
This is with the Enhanced Syntax file
33+
![Enhanced JavaScript Vim syntax](http://i.imgur.com/cmgdlO6.png)
2634
### Installation
2735
- Using [NeoBundle](https://github.com/Shougo/neobundle.vim) **(Which I recommend)**,
2836
add this line to your `.vimrc`
@@ -44,29 +52,37 @@ Plugin 'jelera/vim-javascript-syntax'
4452
```bash
4553
git clone https://github.com/jelera/vim-javascript-syntax.git ~/.vim/bundle/vim-javascript-syntax
4654
```
55+
4756
### Suggested Companion Plugins
4857
- **Indentation**, can be achieved with [Javascript-Indent](https://github.com/vim-scripts/JavaScript-Indent) by Preston Koprivica. On my testing, it has proved to be the most capable and also indents HTML and JS inside HTML.
4958
The project is unmaintained for now, but you could fork it and improve upon it.
5059
- **Autocompletion** by [Tern for Vim](https://github.com/marijnh/tern_for_vim)
5160
- Popular **third-party libraries support** like jQuery, YUI, Prototype, by [javascript-libraries-syntax](https://github.com/othree/javascript-libraries-syntax.vim)
5261

62+
5363
### Contributions
54-
Always welcome, make sure your commit message should follow this
64+
This project follows the
65+
[Git-flow](http://nvie.com/posts/a-successful-git-branching-model/) methodology,
66+
this will keep the master branch clean for new stable releases.
67+
68+
More about Git-flow at:
69+
- [Daniel Kummer's Git Flow cheatsheet](http://danielkummer.github.io/git-flow-cheatsheet/)
70+
- [Sayanee Basu's Build Podcast - Git Flow](https://www.youtube.com/watch?v=Hh-jJcJ5IJ8)
71+
72+
#### For new contributors
73+
Follow this steps
74+
- Clone this repository.
75+
- Using the command line, run `git flow init -d`.
76+
- Checkout the `develop` branch.
77+
- For new features: Create a new `feature` branch using git-flow.
78+
- For bugfixes: Commit in the `develop` branch.
79+
- Bump the date on the syntax file.
80+
- When done, don't forget to push the `develop` branch.
81+
- Submit a pull request.
82+
83+
While all contributions are always welcome, make sure your commit message follow this
5584
[**convention**](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
5685

57-
### [Screenshots](http://imgur.com/a/7bnu3)
58-
This is the stock Javascript syntax file
59-
#### Solarized Light
60-
![Stock Vim JavaScript syntax file](http://i.imgur.com/FCVLMgl.png)
61-
62-
This is with the Enhanced Syntax file
63-
![Enhanced JavaScript Vim syntax](http://i.imgur.com/yGY3Cmm.png)
64-
65-
#### Hybrid
66-
![Stock Vim JavaScript syntax file](http://i.imgur.com/cGb3EjH.png)
67-
68-
This is with the Enhanced Syntax file
69-
![Enhanced JavaScript Vim syntax](http://i.imgur.com/cmgdlO6.png)
7086

7187
### License
7288
The same as Vim

0 commit comments

Comments
 (0)