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

chore: Merge PR #628

Browse Source 
Fix some typos in CONTRIBUTING.md
This commit is contained in:
Rak Laptudirm
2021-06-17 11:04:07 +05:30
committed by GitHub
parent e0e15131bb 1b5c705aa9
commit d1e2dfe051
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -52,7 +52,7 @@ Algorithms in this repo should not be how-to examples for existing JavaScript pa
#### 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.
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 a 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).
@ -76,7 +76,7 @@ To maximize the readability and correctness of our code, we require that new sub
$ standard MyFile.js // if that fails, try: npx standard MyFile.js
```
- Use camelCase for with leading character lowercase for identifier names (variables and functions)
- Use camelCase with the leading character as lowercase for identifier names (variables and functions)
- Names start with a letter
- follow code indentation
- Always use 2 spaces for indentation of code blocks