Skip to content

Commit 20dcf04

Browse files
author
kennyledet
committed
Merge pull request kennyledet#19 from pravsingh/master
fixed types and added the conventions on writing unit test cases
2 parents 8b78011 + 47f386d commit 20dcf04

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,13 @@ Conventions
1818
+ Submissions should follow this directory structure
1919

2020
Algorithm_Name/Language_Name/username_filename.extension
21+
Algorithm_Name/Language_Name/username_filename_unittest.extension
2122

2223
+ It is preferred that you prepend or append your files with your Github username or some identifier to avoid overwriting others' implementations. `git blame` is cool, and has many more appropriate applications, but in this context I'd rather pull a flat list of files and be able to check out everyone's contributions that way than have to look through the revisions.
2324

24-
+ Each algorithm should have its corresppnding unit test cases which covers the corner cases, happy/unhappy path.
25-
Advantage of doing so is to asset that every thing is covered and algorithm is not broken between code change.
26-
It also helps newbie to have a quick look at the unit test cases and understand the basic usecase of the algorithm.
25+
+ Each algorithm should have its corresppnding unit test cases (as directory structure suggested above) which covers the corner cases, happy/unhappy paths.
26+
Advantage of doing so is to assert that every thing is covered and algorithm is not broken between code change.
27+
It also helps newbies to have a quick look at the unit test cases and understand the basic usecase of the algorithm.
2728

2829
+ Documentation inside the code is recommended. This helps others in understanding the code base.
2930

0 commit comments

Comments
 (0)