Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 30 lines (19 sloc) 1.706 kB
0104c06 @AndrewRadev README.md, CONTRIBUTING.md, LICENSE
authored
1 # Contributing
2
3 If you'd like to contribute to the project, you can use the usual github pull-request flow:
4
5 1. Fork the project
6 2. Make your change/addition, preferably in a separate branch.
7 3. Test the new behaviour and make sure all existing tests pass (optional, see below for more information).
8 4. Issue a pull request with a description of your feature/bugfix.
9
10 ## Testing
11
12 This project uses [rspec](http://rspec.info/) and [vimrunner](https://github.com/AndrewRadev/vimrunner) to test its behaviour. Testing vimscript this way is still fairly experimental, but does a great job of catching regressions. Tests are written in the ruby programming language, so if you're familiar with it, you should (I hope) find the tests fairly understandable and easy to get into.
13
14 If you're not familiar with ruby, please don't worry about it :). I'd definitely appreciate it if you could take a look at the tests and attempt to write something that describes your change. Even if you don't, Travis-bot should run the tests upon issuing a pull request, so we'll know right away if there's a regression. In that case, I'll work on the tests myself and see what I can do.
15
16 To run the test suite, provided you have ruby installed, first you need bundler:
17
18 ```
19 $ gem install bundler
20 ```
21
22 If you already have the `bundle` command (check it out with `which bundle`), you don't need this step. Afterwards, it should be as simple as:
23
24 ```
25 $ bundle install
26 $ bundle exec rspec spec
27 ```
28
29 Depending on what kind of Vim you have installed, this may spawn a GUI Vim instance, or even several. You can read up on [vimrunner's README](https://github.com/AndrewRadev/vimrunner/blob/master/README.md) to understand how that works.
Something went wrong with that request. Please try again.