Merge pull request #36 from SamikshaSankar/SamikshaSankar-patch-2

Upadte readme file

CONTRIBUTING.md

@@ -1 +1,49 @@
-
+  1. #### Firstly, [install git](https://help.github.com/articles/set-up-git/).
+
+2. ## Forking repository :
+   This will create a copy of this repository in your account.
+
+   Fork <a href="https://github.com/SubhamKarmakar24/snake" target="_blank">this</a> repository.
+
+3. ## Clone repository :
+   This will create a copy of this repository in your local machine. Now You are ready to make changes as per your issue.
+   ```
+   git clone https://github.com/SubhamKarmakar24/snake.git
+   ```
+    #### The steps to follow to contribute to any projects:
+
+4. ### Add a upstream link to main branch in your cloned repo
+    ```
+    git remote add upstream https://github.com/SubhamKarmakar24/snake.git
+    ```
+5. ### Keep your cloned repo upto date by pulling from upstream 
+   This will also avoid any merge conflicts while committing new changes
+    ```
+    git pull upstream main
+    ```
+6. ### Create your feature branch 
+   Always create new branch
+    ```
+    git checkout -b <feature-name>
+    ```
+7. ### Track your changes
+    ```
+    git add .
+    ```
+8. ### Check for your changes.
+    ```
+    git status
+    ```
+9. ### Commit all the changes 
+    Write commit message as "Small Message"
+    ```
+    git commit -m "Write a meaningfull but small commit message"
+    ```
+10. ### Push the changes for review
+    ```
+    git push origin <branch-name>
+    ```
+11. ### Create a PR on Github. 
+    Just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing
+
+    ### Happy Coding and Contributing!!

README.md

@@ -1,13 +1,74 @@
-## Snake
-> We all have played this game, haven't we. So, the basic knowledge about this repository is that a snake moves to eat its food and dies if it eats itself.
->
-> There are several mazes and levels to choose from and try getting a high score
->
-> There is also an instructions tab which enables players to know how to play.
+<div align="center">
+  <h1>Snake</h1>
+  <img src="assets/snake.png " />
+</div>
+<hr>
 
-Fork this repository and then clone the forked repo to work on it and run index.html file
+## About
+We all have played this game, haven't we. So, the basic knowledge about this repository is that a snake moves to eat its food and dies if it eats itself. There are several mazes and levels to choose from and try getting a high score. There is also an instructions tab which enables players to know how to play. [Visit website](https://subhamkarmakar24.github.io/snake/)
 
-The game is available at https://subhamkarmakar24.github.io/snake/
+<div align="center">
+
+<a href="https://github.com/SubhamKarmakar24/snake/stargazers"><img src="https://img.shields.io/github/stars/SubhamKarmakar24/snake?color=brightgreen"></a>
+<a href="https://github.com/SubhamKarmakar24/snake/network/members"><img src="https://img.shields.io/github/forks/SubhamKarmakar24/snake?color=brightgreen"></a>
+<a href="https://github.com/SubhamKarmakar24/snake/graphs/contributors"><img src="https://img.shields.io/github/contributors/SubhamKarmakar24/snake?color=brightgreen"></a>
+<a href="https://github.com/SubhamKarmakar24/snake/issues"><img src="https://img.shields.io/github/issues/SubhamKarmakar24/snake?color=brightgreen"></a>
+<a href="https://github.com/SubhamKarmakar24/snake/pulls"><img src="https://img.shields.io/github/issues-pr/SubhamKarmakar24/snake?color=brightgreen"></a>
 
-Feel free to contribute : )
+</div>
+<hr>
+
+## Contribution Guidelines
+
+The steps to follow to contribute to any projects:
+
+1. #### Firstly, [install git](https://help.github.com/articles/set-up-git/).
+
+2. ## Fork this repository
+   This will create a copy of this repository in your account.
+
+   Fork <a href="https://github.com/SubhamKarmakar24/snake" target="_blank">this</a> repository.
+
+3. ## Clone the repository
+   This will create a copy of this repository in your local machine. Now You are ready to make changes as per your issue.
+   ```
+   git clone https://github.com/SubhamKarmakar24/snake.git
+   ```
+
+4. ### Add a upstream link to main branch in your cloned repo
+    ```
+    git remote add upstream https://github.com/SubhamKarmakar24/snake.git
+    ```
+5. ### Keep your cloned repo upto date by pulling from upstream 
+   This will also avoid any merge conflicts while committing new changes
+    ```
+    git pull upstream main
+    ```
+6. ### Create your feature branch 
+   Always create new branch
+    ```
+    git checkout -b <feature-name>
+    ```
+7. ### Track your changes
+    ```
+    git add .
+    ```
+8. ### Check for your changes.
+    ```
+    git status
+    ```
+9. ### Commit all the changes 
+    Write commit message as "Small Message"
+    ```
+    git commit -m "Write a meaningfull but small commit message"
+    ```
+10. ### Push the changes for review
+    ```
+    git push origin <branch-name>
+    ```
+11. ### Create a PR on Github. 
+    Just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing
+<hr>
+
+#### Feel free to contribute : )