algorithm/JavaScript
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/JavaScript.git synced 2025-07-06 09:28:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Doctest Contribution Guidelines | Added Description

Browse Source
This commit is contained in:
marsonya
2020-11-02 19:56:03 +05:30
parent 7a050aba5b
commit e720b7d5c9
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -81,6 +81,10 @@ To maximize the readability and correctness of our code, we require that new sub
- We strongly recommend the use of ECMAScript 6
- Avoid importing external libraries for basic algorithms. Only use those libraries for complicated algorithms.
#### Testing
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.
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.
- Most importantly,