]> git.madduck.net Git - etc/vim.git/blobdiff - 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:

Update AUTHORS.rst
[etc/vim.git] / CONTRIBUTING.md
index 232117267749e05d24e2b112e683bdfb68a1a610..74fe90d74779e2b6d5cb16bb10b3bb80b8e05076 100644 (file)
@@ -9,8 +9,17 @@ Please:
 - Write [good commit messages].
 - Ideally, [squash] your commits, i.e. make your pull requests just one commit.
 
 - Write [good commit messages].
 - Ideally, [squash] your commits, i.e. make your pull requests just one commit.
 
+## Running Tests
+
+- They are written in ruby (sorry :() using [vimrunner] which requires [rspec]
+- The tests go into `spec/indent/indent_spec.rb`.
+  Look at the `describe` blocks to get the hang of it.
+- Run the tests with the command `rspec spec`
+
 Thank you for considering to contribute!
 
 
 [squash]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
 [good commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
 Thank you for considering to contribute!
 
 
 [squash]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
 [good commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[vimrunner]: https://github.com/AndrewRadev/vimrunner
+[rspec]: https://github.com/rspec/rspec