CONTRIBUTING.rst

   1 How To Contribute
   2 =================
   3
   4 ``vim-python-pep8-indent`` is always open for suggestions and contributions by generous developers.
   5 I’ve collected a few tips to get you started.
   6
   7 Please:
   8
   9 - *Always* add tests for your code.
  10 - Write `good commit messages`_.
  11
  12
  13 Running Tests
  14 -------------
  15
  16 - They are written in Ruby_ (sorry :() using vimrunner_ which requires rspec_.
  17 - The tests go into ``spec/indent/indent_spec.rb``.
  18   Look at the ``describe`` blocks to get the hang of it.
  19 - Run the tests with the command::
  20
  21    $ rspec spec
  22 - Alternatively you can use Docker::
  23
  24    $ make test_docker
  25
  26 - You can select tests based on line numbers, e.g.::
  27
  28    $ rspec ./spec/indent/indent_spec.rb:385
  29    $ make test_docker RSPEC_ARGS=./spec/indent/indent_spec.rb:385
  30
  31 Thank you for considering to contribute!
  32
  33
  34 .. _Ruby: https://www.ruby-lang.org/
  35 .. _`good commit messages`: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
  36 .. _vimrunner: https://github.com/AndrewRadev/vimrunner
  37 .. _rspec: https://github.com/rspec/rspec