Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added more information about what we're looking for in pull requests.

  • Loading branch information...
commit a1dad156d0ac4e238cec3dd94bf253739734460d 1 parent dc4a16a
@spraints spraints authored
Showing with 13 additions and 1 deletion.
  1. +13 −1 CONTRIBUTING.md
View
14 CONTRIBUTING.md
@@ -10,5 +10,17 @@
## Pull Requests
-* In general, pull requests with unit tests get merged quicker than those without.
+Here are some tips on creating a pull request:
+1. Write awesome code. :sparkles:
+
+2. Make sure the existing unit tests don't break. We try to keep the unit tests
+[easy to run](https://github.com/git-tfs/git-tfs/wiki/Running-the-Unit-Tests).
+
+3. We like new unit tests. If you can unit test your code, do so.
+One of the pain points of the current git-tfs codebase is that parts of it are very difficult to unit test.
+It's slowly getting less painful to unit test. One thing to try is to write an integration test
+that runs git-tfs with the VsFake driver, similar to how the clone tests are written.
+
+4. If you modify code in any of the client adapters (GitTfs.Vs*), please try it out with as many versions of the TFS client libraries as you can.
+When you submit the pull request, include a note about which versions you have tried to compile with, and which ones you have tested with.
Please sign in to comment.
Something went wrong with that request. Please try again.