Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 845 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 845 Bytes

Contributing

Testing

Tests are written for vspec, which can be installed via vim-flavor:

bundle install
bundle exec vim-flavor install

The test suite can then be run via the rake task:

bundle exec rake test

Documentation

The documentation in doc/ is generated from the plug-in source code via vimdoc. Do not edit doc/<plugin>.txt directly. Refer to the existing inline documentation as a guide for documenting new code.

The help doc can be rebuilt by running:

bundle exec rake doc

Automation

If you wish, you may use the provided Guardfile to automatically run tests and rebuild the documentation as you make changes:

bundle exec guard start