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

Doctest Contribution Guidelines | Implementation details and reference

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

12
CONTRIBUTING.md
View File

@ -86,6 +86,18 @@ To maximize the readability and correctness of our code, we require that new sub
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. 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. 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.
The implementation of doctest is quite simple. You can easily learn it [here](https://www.npmjs.com/package/doctest).
It is advised that you add the Doctests in a multiline comment just after the Algorithm description.
/**
* Algorithm Description Here
* The Wikipedia Link
*/
/**
* Doctests Here
*/
For Code Structure reference see [this file](https://github.com/TheAlgorithms/Javascript/blob/master/Sorts/BubbleSort.js).
- Most importantly, - Most importantly,
- **Be consistent in the use of these guidelines when submitting.** - **Be consistent in the use of these guidelines when submitting.**