File tree Expand file tree Collapse file tree 2 files changed +25
-0
lines changed Expand file tree Collapse file tree 2 files changed +25
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Contributing to Godash
2
+
3
+ Thank you for contributing to Godash.
4
+
5
+ When contributing to this repository, make sure to first raise an [ Issue] ( https://github.com/thecasualcoder/godash/issues ) about the requirements.
6
+ The issue should have detailed API of how the function will work. Any special validations can be mentioned explicitly.
7
+
8
+ ## Pull Request Process
9
+
10
+ Ensure the PR checklist is completed:
11
+
12
+ - Validations for types involved in the function.
13
+ - Tests for the function that covers all branches.
14
+ - All tests should pass.
15
+ - ExampleTest of the function for GoDoc
16
+ - README.md on how to use the functions
17
+ - Comment on the function explaining how it works and the various validations done
Original file line number Diff line number Diff line change
1
+ ## Checklist for PR
2
+
3
+ [ ] Link to corresponding Issue.
4
+ [ ] Tests covering all the code branches.
5
+ [ ] Validations for all the argument's type. This includes the functions passed as arguments.
6
+ [ ] A Comment on how the function works and what are the different validations in the function.
7
+ [ ] An ExampleTest of the function.
8
+ [ ] README.md should be updated about the function.
You can’t perform that action at this time.
0 commit comments