|
1 | 1 | # Contribution Guide |
2 | 2 |
|
3 | | -Thanks for taking interest and I appreciate your efforts towards making this projects even better. |
| 3 | +Thanks for taking interest and I appreciate your efforts towards making this project even better. |
4 | 4 |
|
5 | 5 | ## How to setup? |
6 | 6 |
|
7 | | -This is the most simple project when it comes to contributions, setup, opening issues/pull requests. So et's get started. |
| 7 | +This is the most simple project when it comes to contributions, setup, opening issues/pull requests. So let's get started. |
8 | 8 |
|
9 | 9 | - Clone the repo using the command `git clone git@github.com:knaxus/problem-solving-javascript.git`<sup>1</sup> |
10 | | -- Install the packages to get suport for linter using `npm install` |
| 10 | +- Install the packages to get support for linter using `npm install` |
11 | 11 |
|
12 | 12 | 1: If you do not have **ssh** setup for github, while cloning go with **https** |
13 | 13 |
|
14 | 14 | ### Before you start, keep the following things in mind: |
15 | 15 | - We use ESLint for code linting |
16 | 16 | - The linter follows [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) |
17 | | -- Go though the folder structure carefully and follow the same |
18 | | -- Go though the format and file convenetions used while adding tests (both test case and test files) |
| 17 | +- Go through the folder structure carefully and follow the same |
| 18 | +- Go through the format and file convenetions used while adding tests (both test case and test files) |
19 | 19 |
|
20 | 20 | ## Adding your code |
21 | 21 |
|
22 | | -- When adding a new problem with solution |
| 22 | +- When adding a new problem with a solution |
23 | 23 | - Take care of the filename convention (Very Important) |
24 | | - - Problem statement should be there and support it with some examples |
25 | | - - Make sure you've add the **Run Time Complexity** of your solution |
| 24 | + - A problem statement should be there and support it with some examples |
| 25 | + - Make sure you've added the **Run Time Complexity** of your solution |
26 | 26 | - Please take care of the segregation of the Problems as per the given Folder Structure |
27 | 27 | - It's great if you can add the Unit Tests to verify your solutions as well |
28 | 28 |
|
29 | 29 | - When adding a Unit Test |
30 | 30 | - Take care of the file name convention |
31 | 31 | - Make sure CI (Travis) is passing |
32 | | - - Expanding the test suite until (close to) 100 percent code coverage is achieved |
| 32 | + - Expanding the test suite until (close to) 100 percentage code coverage is achieved |
33 | 33 |
|
34 | 34 | ### Notes |
35 | 35 |
|
|
0 commit comments