Skip to content

Commit 5e70049

Browse files
authored
Create CONTRIBUTING.md
1 parent 534ce18 commit 5e70049

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# How to Contribute
2+
3+
If you want to implement new methods, follow this general format.
4+
5+
- Method names must match the LeetCode problem name in camel case, e.g. Two Sum -> twoSum
6+
- Method definitions must match the LeetCode definitions provided, types and all (excluding externally defined types like ListNode)
7+
- Test names must be named the same, prefixed with `test_`
8+
- Test cases must match the test cases given by LeetCode
9+
10+
Below are features/documentation that may be implemented in future release, but are not deemed a priority as of now.
11+
12+
- Method documentation
13+
- Assertions to validate method inputs
14+
- Extensive test cases/full code coverage

0 commit comments

Comments
 (0)