1- # Contribution Guide
1+ # Contribution Guide
22
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.
44
55## How to setup?
66
@@ -9,19 +9,22 @@ This is the most simple project when it comes to contributions, setup, opening i
99- Clone the repo using the command ` git clone git@github.com:knaxus/problem-solving-javascript.git ` <sup >1</sup >
1010- Install the packages to get support for linter using ` npm install `
1111
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**
1313
1414### Before you start, keep the following things in mind:
15+
1516- We use ESLint for code linting
1617- The linter follows [ Airbnb JavaScript Style Guide] ( https://github.com/airbnb/javascript )
1718- Go through the folder structure carefully and follow the same
1819- Go through the format and file conventions used while adding tests (both test case and test files)
1920
2021## 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.
2224- If you raise a Pull Request for an issue and the Issue was not assigned to you, your PR will be marked as ** Invalid**
2325
2426## Submittng a Pull Request (PR)
27+
2528- Add yourself to the assignee section
2629- Add meaningful heading and description to your PR
2730- 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
3033## Adding your code
3134
3235- When adding a new problem with a solution
36+
3337 - Take care of the filename convention (Very Important)
3438 - A problem statement should be there and support it with some examples
3539 - Make sure you've added the ** Run Time Complexity** of your solution
3640 - Please take care of the segregation of the Problems as per the given Folder Structure
3741 - 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
3943
4044- When adding a Unit Test
4145 - Take care of the file name convention
0 commit comments