]> git.madduck.net Git - etc/vim.git/blob - CONTRIBUTING.rst

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Fix demo indentation
[etc/vim.git] / 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 - Add yourself to the AUTHORS.rst file in an alphabetical fashion by first name – no matter how big or small your changes are.
11 - Write `good commit messages`_.
12
13
14 Running Tests
15 -------------
16
17 - They are written in Ruby_ (sorry :() using vimrunner_ which requires rspec_.
18 - The tests go into ``spec/indent/indent_spec.rb``.
19   Look at the ``describe`` blocks to get the hang of it.
20 - Run the tests with the command::
21
22    $ rspec spec
23
24 Thank you for considering to contribute!
25
26
27 .. _Ruby: https://www.ruby-lang.org/
28 .. _`good commit messages`: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
29 .. _vimrunner: https://github.com/AndrewRadev/vimrunner
30 .. _rspec: https://github.com/rspec/rspec