1
- # Contribution Guide
1
+ # Contribution Guide
2
2
3
- Thanks for taking interest and I appreciate your efforts towards making this project 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
@@ -9,19 +9,22 @@ This is the most simple project when it comes to contributions, setup, opening i
9
9
- Clone the repo using the command ` git clone git@github.com:knaxus/problem-solving-javascript.git ` <sup >1</sup >
10
10
- Install the packages to get support for linter using ` npm install `
11
11
12
- 1: If you do not have ** ssh** setup for github, while cloning go with ** https**
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
16
- We use ESLint for code linting
16
17
- The linter follows [ Airbnb JavaScript Style Guide] ( https://github.com/airbnb/javascript )
17
18
- Go through the folder structure carefully and follow the same
18
19
- Go through the format and file conventions used while adding tests (both test case and test files)
19
20
20
21
## How to pick up an Issue
21
- - Comment on the issue first so that we can assign you the issue.
22
+
23
+ - Comment on the issue first so that we can assign you the issue.
22
24
- If you raise a Pull Request for an issue and the Issue was not assigned to you, your PR will be marked as ** Invalid**
23
25
24
26
## Submittng a Pull Request (PR)
27
+
25
28
- Add yourself to the assignee section
26
29
- Add meaningful heading and description to your PR
27
30
- Also mention the issue number in the description using ** '#'** , e.g: ** #12 **
@@ -30,12 +33,13 @@ This is the most simple project when it comes to contributions, setup, opening i
30
33
## Adding your code
31
34
32
35
- When adding a new problem with a solution
36
+
33
37
- Take care of the filename convention (Very Important)
34
38
- A problem statement should be there and support it with some examples
35
39
- Make sure you've added the ** Run Time Complexity** of your solution
36
40
- Please take care of the segregation of the Problems as per the given Folder Structure
37
41
- It's great if you can add the Unit Tests to verify your solutions as well
38
- - Do not forget to update ** [ TOC.md] ( TOC.md ) ** with your new problem or data structure
42
+ - Do not forget to update ** [ TOC.md] ( TOC.md ) ** with your new problem or data structure
39
43
40
44
- When adding a Unit Test
41
45
- Take care of the file name convention
0 commit comments