From 67d6d0017ee31217c1b8284060cca9ef4d744eab Mon Sep 17 00:00:00 2001
From: cefjoeii <cefjoeii@gmail.com>
Date: Sun, 17 Sep 2017 10:23:23 +0800
Subject: [PATCH] Add CONTRIBUTING.md and update instructions

---
 CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++
 README.md       | 31 ++++++++++++++-----------------
 2 files changed, 53 insertions(+), 17 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..a82b70f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,39 @@
+# Contributing to MERN CRUD
+
+Thank you for considering contributing to this little project!
+
+<br>
+
+## Features you are encouraged to implement
+
+* Tests
+* Search
+* Front-end validation (JS); Pure back-end validation is expensive
+* Routing / redirecting / whatever
+* Redux
+
+## Coding conventions
+* Indent using two spaces (soft tabs).
+* Integrate *eslintrc.json* to your text editor or IDE.
+
+
+<br>
+
+## Fork, then clone the repo.
+```bash
+git clone https://github.com/<your-user-name>/mern-crud.git
+```
+
+## Commit
+Make sure your commit messages are in present tense.
+
+This:
+```bash
+git commit -m "Fix bugs and update colors" 
+```
+Not this:
+```bash
+git commit -m "Fixed bugs and updated colours"
+```
+
+## Push to your Fork and make a pull request.
diff --git a/README.md b/README.md
index 653c621..d087b99 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,8 @@ A simple records system using MongoDB, Express.js, React.js, and Node.js with re
 
 ![Node Version](https://img.shields.io/badge/node-v6.11.0-yellowgreen.svg)
 ![NPM Version](https://img.shields.io/badge/npm-v3.10.10-blue.svg)
+![MongoDB Version](https://img.shields.io/badge/mongodb-v3.4.2-blue.svg)
+![Mongoose Version](https://img.shields.io/badge/mongoose-v4.10.8-blue.svg)
 ![Language: American English](https://img.shields.io/badge/language-american%20english-red.svg)
 
 
@@ -13,9 +15,9 @@ Demo: [https://mern-crud.herokuapp.com/](https://mern-crud.herokuapp.com/)
 
 ## Instructions
 
-Download or clone.
-```
-git clone https://github.com/cefjoeii/mern-crud.git
+Fork, then download or clone the repo.
+```bash
+git clone https://github.com/<your-user-name>/mern-crud.git
 ```
 
 
@@ -29,12 +31,12 @@ module.exports = {
 ```
 
 For the **back-end**, install the dependencies once via the terminal.
-```
+```bash
 npm install
 ```
 
 Run the *main server*. It listens on port 3000.
-```
+```bash
 node server
 ```
 View it on the browser.
@@ -43,17 +45,17 @@ View it on the browser.
 
 If you want to configure the **front-end**, go to *react-src* folder via the terminal.
 
-```
+```bash
 cd react-src
 ```
 
 Install the dependencies required by React once.
-```
+```bash
 npm install
 ```
 
 Run the *development server* for React. It listens on port 4200.
-```
+```bash
 npm start
 ```
 Since it's running on a different port, we need to enable CORS. Locate the file called *server.js* on the root directory. Find and uncomment this line of code. Remember to comment it back out when deploying.
@@ -62,7 +64,7 @@ Since it's running on a different port, we need to enable CORS. Locate the file
 ```
 
 To make a production build, simply run on *react-src* folder via the terminal.
-```
+```bash
 npm run build
 ```
 
@@ -70,6 +72,9 @@ It re-creates a folder named *public* on the root directory. This is where the p
 
 <br>
 
+## Contributing
+* [CONTRIBUTING](CONTRIBUTING.md)
+
 ## To Do
 
 - [x] Create
@@ -80,13 +85,5 @@ It re-creates a folder named *public* on the root directory. This is where the p
 - [x] Deploy in Heroku
 - [x] Front-end validation (HTML)
 
-## Future Plans
-
-* Search
-* Front-end validation (JS); Pure back-end validation is expensive
-* Routing / redirecting / whatever
-* Learn Redux
-* Learn creating tests
-
 ## License
 * [MIT](LICENSE)