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

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:

74fe90d74779e2b6d5cb16bb10b3bb80b8e05076
[etc/vim.git] / CONTRIBUTING.md
1 # How To Contribute
2
3 “vim-python-pep8-indent” is always open for suggestions and contributions by generous developers. I’ve collected a few tipps to get you started.
4
5 Please:
6
7 - *Always* add tests for your code.
8 - Add yourself to the AUTHORS.rst file in an alphabetical fashion by first name – no matter how big or small your changes are.
9 - Write [good commit messages].
10 - Ideally, [squash] your commits, i.e. make your pull requests just one commit.
11
12 ## Running Tests
13
14 - They are written in ruby (sorry :() using [vimrunner] which requires [rspec]
15 - The tests go into `spec/indent/indent_spec.rb`.
16   Look at the `describe` blocks to get the hang of it.
17 - Run the tests with the command `rspec spec`
18
19 Thank you for considering to contribute!
20
21
22 [squash]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
23 [good commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
24 [vimrunner]: https://github.com/AndrewRadev/vimrunner
25 [rspec]: https://github.com/rspec/rspec