Skip to content

Commit d1e2dfe

Browse files
authored
chore: Merge PR #628
Fix some typos in CONTRIBUTING.md
2 parents e0e1513 + 1b5c705 commit d1e2dfe

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ Algorithms in this repo should not be how-to examples for existing JavaScript pa
4646

4747
#### File Naming Convention
4848
- filenames should use the UpperCamelCase (PascalCase) style.
49-
- There should be no spaces in filenames.
49+
- There should be no spaces in filenames.
5050
**Example:**`UserProfile.js` is allowed but `userprofile.js`,`Userprofile.js`,`user-Profile.js`,`userProfile.js` are not
5151

5252
#### Testing
5353

54-
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.
55-
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.
54+
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.
55+
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.
5656

5757
The implementation of doctest is quite simple. You can easily learn it [here](https://www.npmjs.com/package/doctest).
5858

@@ -76,23 +76,23 @@ To maximize the readability and correctness of our code, we require that new sub
7676
$ standard MyFile.js // if that fails, try: npx standard MyFile.js
7777
```
7878
79-
- Use camelCase for with leading character lowercase for identifier names (variables and functions)
79+
- Use camelCase with the leading character as lowercase for identifier names (variables and functions)
8080
- Names start with a letter
8181
- follow code indentation
8282
- Always use 2 spaces for indentation of code blocks
8383
```
8484
function sumOfArray (arrayOfNumbers) {
85-
let sum = 0
86-
for (let i = 0; i < arrayOfNumbers.length; i++) {
87-
sum += arrayOfNumbers[i]
88-
}
89-
return (sum)
85+
let sum = 0
86+
for (let i = 0; i < arrayOfNumbers.length; i++) {
87+
sum += arrayOfNumbers[i]
9088
}
89+
return (sum)
90+
}
9191
9292
```
9393
- Avoid using global variables and avoid '=='
9494
- Please use 'let' over 'var'
95-
- Please use 'console.log()'
95+
- Please use 'console.log()'
9696
- We strongly recommend the use of ECMAScript 6
9797
- Avoid importing external libraries for basic algorithms. Only use those libraries for complicated algorithms.
9898
- Most importantly,

0 commit comments

Comments
 (0)