init: CONTRIBUTING.md

Author: 0x48piraj

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+## Things to remember
+
+**Commits**
+
+* Write clear meaningful git commit messages (Do read 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. (More info at https://github.com/blog/1506-closing-issues-via-pull-requests )
+* When you make very very minor changes to a PR of yours (like for example fixing a failing travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterwards so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at https://davidwalsh.name/squash-commits-git )
+* When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.
+* Do remember to add a description to your pull request.
+
+**Code Styleguide**
+
+* Do follow the .editorconfig file regarding maintaining of code style (It's mandatory).
+* For more information regarding .editorconfig file, see [editorconfig](http://editorconfig.org/#download)
+
+**Feature Requests and Bug Reports**
+
+* When you file a feature request or when you are submitting a bug report to the [issue tracker](https://github.com/MFOSSociety/MFOSSociety.github.io/issues), make sure you add steps to reproduce it. Especially if that bug is some weird/rare one.
+
+**Join the development**
+
+* Before you join development, please set up the project on your local machine, run it and go through the application completely. Press on any button you can find and see where it leads to. Explore. (Don't worry ... Nothing will happen to the app or to you due to the exploring :wink: Only thing that will happen is, you'll be more familiar with what is where and might even get some cool ideas on how to improve various aspects of the app.)
+* If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely.

README.md

@@ -6,7 +6,7 @@
 **Visit :** https://mfossociety.github.io/
 
 
-## Things you should know before contributing:
+## Things you should know before contributing
 
 - All pull requests need to be associated to an issue.
 - All PRs need to be assigned to the person working on it.
@@ -38,8 +38,9 @@
 **Now you can start working on issues.**
 
 
-## How to add yourself to developer section to the website:
-- Choose any current mentor and seek permission before making Pull Request
+## How to add yourself to developer section to the website
+
+- Choose any current mentor and seek permission before making **Pull Request**
 - Size of the profile image - 240x240 px
 - Upload the picture to the img/students folder - with a suitable name
 -  Add yourself to the `_data/students.yml file` as shown below