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 Thank you for considering to contribute!
  13
  14
  15 [squash]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
  16 [good commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html