Skip to content

Commit e720b7d

Browse files
committed
Doctest Contribution Guidelines | Added Description
1 parent 7a050ab commit e720b7d

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ To maximize the readability and correctness of our code, we require that new sub
8181
- We strongly recommend the use of ECMAScript 6
8282
- Avoid importing external libraries for basic algorithms. Only use those libraries for complicated algorithms.
8383
84+
#### Testing
85+
86+
Be confident that your code works. When was the last time you committed a code change, your build failed, and half of your app stopped working? Mine was last week. Writing tests for our Algorithms will help us ensure the implementations are air tight even after multiple fixes and code changes.
87+
We use a NPM package [doctest](https://www.npmjs.com/package/doctest) to add basic testing functionality to our code. Doctests are simple structured comments that evaluate an function and ensure a required result.
8488
8589
8690
- Most importantly,

0 commit comments

Comments
 (0)