|
| 1 | +# Contribution Guide |
| 2 | + |
| 3 | +Thanks for taking interest and I appreciate your efforts towards making this projects even better. |
| 4 | + |
| 5 | +## How to setup? |
| 6 | + |
| 7 | +This is the most simple project when it comes to contributions, setup, opening issues/pull requests. So et's get started. |
| 8 | + |
| 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` |
| 11 | + |
| 12 | +1: If you do not have **ssh** setup for github, while cloning go with **https** |
| 13 | + |
| 14 | +### Before you start, keep the following things in mind: |
| 15 | +- We use ESLint for code linting |
| 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) |
| 19 | + |
| 20 | +## Adding your code |
| 21 | + |
| 22 | +- When adding a new problem with solution |
| 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 |
| 26 | + - Please take care of the segregation of the Problems as per the given Folder Structure |
| 27 | + - It's great if you can add the Unit Tests to verify your solutions as well |
| 28 | + |
| 29 | +- When adding a Unit Test |
| 30 | + - Take care of the file name convention |
| 31 | + - Make sure CI (Travis) is passing |
| 32 | + |
| 33 | +### Notes |
| 34 | + |
| 35 | +- Keep an eye on this guide, it's subjected to change frequently. |
| 36 | +- Please do not break the ESLint rules |
| 37 | +- Todo |
| 38 | + - Issue Template |
| 39 | + - PR Template |
0 commit comments