Add a quick contributions guideline

mike-burns · mike-burns · commit a26e6cc153c9 · 2012-04-09T21:19:08.000-04:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,26 @@
+Contributing
+------------
+
+When adding a new public function
+=================================
+
+* Write a sample in the appropriate place in the samples/ directory.
+* Implement the function.
+* Submit a pull request.
+
+When modifying an existing data structure
+=========================================
+
+* Find all samples that use the data structure and make sure they run.
+* Modify the data structure.
+* Modify the samples as appropriate.
+* Make sure all relevant samples still run.
+* Submit a pull request.
+
+Submitting a pull request
+=========================
+
+* If your code is radically different from existing functionality, give
+some explanation for how it fits in this library.
+* Create a topic branch on your fork.
+* Rebase and squash your commits.
diff --git a/README.md b/README.md
@@ -43,6 +43,10 @@ All functions produce an `IO (Either Error a)`, where `a` is the actual thing yo
                         (intercalate "\n" . map githubUserLogin)
                         possibleUsers
 
+Contributions
+=============
+
+Please see [CONTRIBUTING.md](https://github.com/mike-burns/github/tree/master/CONTRIBUTING.md) for details on how you can help.
 
 Copyright
 =========
