Add github templates

thecasualcoder · Oct 13, 2019 · cf513bc · cf513bc
1 parent fd0197d
commit cf513bc
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/.github/contributing.md b/.github/contributing.md
@@ -0,0 +1,17 @@
+# Contributing to Godash
+
+Thank you for contributing to Godash.
+
+When contributing to this repository, make sure to first raise an [Issue](https://github.com/thecasualcoder/godash/issues) about the requirements.
+The issue should have detailed API of how the function will work. Any special validations can be mentioned explicitly. 
+
+## Pull Request Process
+
+Ensure the PR checklist is completed:
+
+- Validations for types involved in the function.
+- Tests for the function that covers all branches.
+- All tests should pass.
+- ExampleTest of the function for GoDoc
+- README.md on how to use the functions
+- Comment on the function explaining how it works and the various validations done
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,8 @@
+## Checklist for PR
+
+[] Link to corresponding Issue.
+[] Tests covering all the code branches.
+[] Validations for all the argument's type. This includes the functions passed as arguments.
+[] A Comment on how the function works and what are the different validations in the function.
+[] An ExampleTest of the function.
+[] README.md should be updated about the function.