Repository files navigation

This project contains Vim's runtime files for ruby support. This includes syntaxhighlighting, indentation, omnicompletion, and various useful tools and mappings.

See the fileINSTALL.markdown for instructions.

You might also find useful setup tips in the github wiki:https://github.com/vim-ruby/vim-ruby/wiki/VimRubySupport

Ideally, vim-ruby should work "correctly" for you out of the box. However, rubydevelopers have varying preferences, so there are settings that control some ofthe details. You can get more information on these by using the native:helpcommand:

• :help vim-ruby-plugin: Filetype settings and custom mappings
• :help vim-ruby-indent: Indentation settings
• :help vim-ruby-syntax: Syntax-related tweaks
• :help vim-ruby-omni: Information and settings for omni completion

If you have an issue or a feature request, it's recommended to use the githubissue tracker:https://github.com/vim-ruby/vim-ruby/issues. Try the search boxto look for an existing issue -- it might have already been reported.

If you don't have a github account or would rather contact us in a differentway, you can find emails for individual maintainers in theCONTRIBUTORS file. They're also in the comment headers of theproject's Vimscript files (syntax/ruby.vim,indent/ruby.vim, etc) under thelabel "Maintainer".

If you're not sure who the most relevant person to contact is for yourparticular issue, you can send an email to the release coordinator, Doug Kearns(dougkearns at gmail.com).

Vim-ruby is a mature project, which is one way of saying it moves slowly and itcan be a bit difficult to modify. It's far from impossible, but be warned thatissues and PRs may take time to be handled. Partly, it's because we don't wantto risk breaking Vim's core ruby support, partly because it takes a lot of timeand energy to debug and fix things.

Contributing a fix for an issue would be very appreciated, even if it's aproof-of-concept to start a conversation. Be warned that we're definitely goingto be conservative when considering changes to vim-ruby.

The code is tested usingRSpec andVimrunner. The tests are notexhaustive, but they should cover a wide variety of cases.

This project began in July 2003, when the current version of Vim was 6.2. Itwas migrated from CVS in August, 2008.

If you're curious about individual pre-git changes, you can read some of themin the (unmaintained)NEWS and/orChangeLog files.