readme update

CONTRIBUTIONS.md

@@ -0,0 +1,88 @@
+# CONTRIBUTIONS
+
+<aside>
+☝ When contributing to this repository, please first discuss the changes you wish to make via issue, email, or any other method with the owners of this repository before making a change.
+
+</aside>
+
+## How to Contribute to the Project?
+
+1. Fork this repository.
+
+    When you’re on the main page for the repository, you’ll see a button to "Star" and “Fork” the repository on your upper right-hand side of the page, underneath your user icon.
+
+2. Clone the repository to your local machine.
+
+    You can alternatively copy the URL by using the green “Clone or download” button from your repository page that you just forked from the original repository page. Once you click the button, you’ll be able to copy the URL by clicking the binder button next to the URL. 
+
+    ```bash
+    git clone "<repository link>"
+    ```
+
+3. Create a branch.
+
+    To create your branch, from your terminal window, change your directory so that you are working in the directory of the repository. Be sure to use the actual name of the repository to change into that directory.
+
+    ```bash
+    git checkout -b <branch-name>
+    ```
+
+4. Make your changes. 
+
+    Checkout the issues for the project to contribute to the project. New ideas from your side are also welcome😊.
+
+5. Commit and push
+
+    ```bash
+    git add .
+    git commit -m "<commit description>" 
+    #check [this](https://www.notion.so/CONTRIBUTIONS-be61e21937394af69af5c963fa5689c6) for making commits
+    git push origin <branch name>
+    ```
+
+    The commit message is an important aspect of your code contribution; it helps the other contributors fully understand the change you have made, why you made it, and how significant it is. Additionally, commit messages provide a historical record of the changes for the project at large, helping future contributors along the way. Thus, you must ensure that you write a meaningful commit message.
+
+6. Create a new pull request from your forked repository (Click the `New Pull Request` button located at the top of your repo).
+
+<aside>
+✌️ Wait for your PR review and merge approval!
+**Star this repository** if you had fun!
+
+</aside>
+
+### Updating Local Repository
+
+While working on a project alongside other contributors, it is important for you to keep your local repository up-to-date with the project as you don’t want to make a pull request for code that will cause conflicts. To keep your local copy of the code base updated, you’ll need to sync changes.
+
+1. Configure remote for the fork.
+
+    You’ll have to specify a new remote upstream repository for us to sync with the fork. This will be the original repository that you forked from. you’ll have to do this with the git remote add command.
+
+    ```bash
+    git remote add upstream <original repo link>
+    ```
+
+2. Sync the Fork.
+
+    Once you have configured a remote that references the upstream and original repository on GitHub, you are ready to sync your fork of the repository to keep it up-to-date.
+
+    ```bash
+    git fetch upstream
+    ```
+
+    Switch to the local master branch of our repository. 
+    Now merge any changes that were made in the original repository’s master branch, that you will access through your local upstream/master branch, with your local master branch.
+
+    ```bash
+    git checkout master
+    git merge upstream/master
+    ```
+
+
+## Making Commits
+
+- Write clear meaningful git [commit messages](http://chris.beams.io/posts/git-commit/).
+- Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check [this](https://github.com/blog/1506-closing-issues-via-pull-requests) for more info)
+- If you're making very, very small changes to your PR (such as making some minor style corrections or minor changes requested by reviewers), make sure you [squeeze](https://davidwalsh.name/squash-commits-git) your commits afterwards, so you don't have an absurd number of commits for a very small fix.
+- If you are submitting a PR for a UI-related topic, it would be really awesome if you could add a screenshot of your change or a link to a deployment where it can be tested along with your PR. This makes it very easy for reviewers and you will also get reviews faster.
+- *design related

README.md

@@ -1,6 +1,12 @@
 # Backend-Automation
+A NPM package that takes care of the all the hassle in setting a basic Express.js backend server. Just install the package on your terminal and run the command to setup a basic Express server on Node.js with MongoDB as the database of choice. The is to ease the backend development process by eliminating the time spent in setting up a server with the basic CRUD operations. 
 
-### Install The Package Using npm: ``` npm install backend-automation```
+## How to Use <br>
+
+<h3> 
+
+Install The Package Using npm: ``` npm install backend-automation``` 
+</h3>
 
 Npm package to initialize backend with CRUD operation in expressjs
 
@@ -9,24 +15,77 @@ Link To NPM Package : https://www.npmjs.com/package/backend-automation
 
 ```
 
-## To Run And Test The NPM Package, Run The Following Commands
+<h3>To Run And Test The NPM Package, Run The Following Commands</h3>
+
 
-### Inside ```Root``` Directory
+1. Inside ```Root``` Directory
 
-```npm install```
+    ```npm install```
 
-### Inside ```/bin``` Directory
+2. Inside ```/bin``` Directory
 
-#### Make Your Changes In The ```index.ts``` File
+3. Make Your Changes In The ```index.ts``` File
 
-#### Compile The Typescript File
+4. Compile The Typescript File
 
 ```
 tsc index.ts
 
 This will generate the compiled javascript version of Typescript File
 ```
 
-### Run the bin Command ```backend-automation``` in Powershell And Test The Changes Made !
+<h3>
+
+ Run the bin Command ```backend-automation``` in Powershell And Test The Changes Made !</h3>
+
+# How to Contribute
+
+We follow a systematic Git Workflow -
+
+- Create a fork of this repo.
+- Clone your fork of your repo on your pc.
+- [Add Upstream to your clone](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork)
+- **Every change** that you do, it has to be on a branch. Commits on master would directly be closed.
+- Make sure that before you create a new branch for new changes, [syncing with upstream](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork) is necessary.
+<br>
+
+<h3 color="grey"> 
+
+Make sure you read the [CONTRIBUTIONS](./CONTRIBUTIONS.md) before you start contributing such that you make remarkable and easily acceptable PRs.</h3>
+<br>
+
+# OWASP Student Chapter, TIET
+
+![logo-owasp.png](assets/logo-owasp.png) <br><br>
+
+<h3 align="center">Thapar Institute of Engineering and Technology (TIET) has been a steady source of highly skilled talent to the nation as well as overseas. A pioneer in engineering education, research and innovation. The team of OWASP Student Chapter, one of the gilt-edged coding society, involves ingenious mind solvers who are eager to make the world a better place to live in with their innovative techniques and discoveries. By successfully organising many hackathons, tech-talks, workshops and coding nights, we have always strived hard to maintain the coding culture throughout the campus.</h3><br>
+
+<p align="center">
+
+Check out our work at [owasp.co.in](http://owasp.co.in) </p>
+
+## Contact Us
+<p style="text-align: center;">
+
+<h3>
+
+[Instagram](https://www.instagram.com/owasp_tiet/)
+</h3>
+
+<h3>
+
+[Github](https://github.com/OWASP-STUDENT-CHAPTER)
+</h3>
+
+<h3>
+
+[Twitter](https://twitter.com/Owasp_tiet)
+</h3>
+
+<h3>
+
+[Linkedin](https://www.linkedin.com/company/owasp-tiet/)
+</h3>
+</p>
+
 
-### Once Satisfied, Raise A Pull Request And Wait For It To Get Merged !