36 lines (35 loc) · 1.15 KB

Contribution and Add Review - Guidelines

Create a issue with your 'Roll no.' as title and your 'name' in the description.
FORK the repo
Clone your forked repo
Create new Branch
```
$ git checkout review/<your-name>
```
Go to /src/review.js you will get a array of objects reviews.

Copy the following object schema and replace the values

{
    name: "Your Name", //string
    rollno: "Your Roll No.", //string
    rate: rating-Out-Of-5, //number
    review: "Good Workshop", //string
    improvements: [ //Array of Strings
        "improvement 1",
        "improvement 2"
    ],
},

You can leave the improvements blank like this improvements: [], if you have noting to say.

Add a new object in that reviws array.
```
$ git add . 
```
```
$ git commit -m "Add your message"
```
```
$ git push origin review/<your-name>
```
Go to your git hub and switch to the branch review/<your-name>
Create a pull request with a meaning ful message and adding #<issue number> in the message refering to the issue that you created.