diff options
Diffstat (limited to 'vim/bundle/vim-gitgutter/test/README.markdown')
-rw-r--r-- | vim/bundle/vim-gitgutter/test/README.markdown | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/vim/bundle/vim-gitgutter/test/README.markdown b/vim/bundle/vim-gitgutter/test/README.markdown new file mode 100644 index 0000000..2be0c37 --- /dev/null +++ b/vim/bundle/vim-gitgutter/test/README.markdown @@ -0,0 +1,30 @@ +## Testing vim-gitgutter + +### Run the tests + +```sh +$ cd test +$ ./test +``` + +### Add a new test + +- Add a test file named like `testFoo.vim`. It should have this structure: + +```viml +source helper.vim +call Setup() + +" test code here +``` + +- Run the tests. +- Inspect output (in `foo.actual`) from the new test. If good, copy it to `foo.expected`. +- Run the tests to ensure new test's output is verified. +- Commit changes. + +### Limitations + +- Currently tests are done by writing out a file and comparing it to a known good one. +- There's no support for assertions within the testcase code. + |