Improve Docs

CONTRIBUTING.md

@@ -1,34 +1,24 @@
-## Leapcode Front
+Contributing to LeapCode Frontend
+=========================================
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+Leapcode welcomes contributions to our [open source projects on Github](https://github.com/Leapcode-Open). When contributing, please follow the guidelines mentioned in this document.
 
-### Pre
-- Rename env.example to .env 
-- Download Firebase service account json and add the details to env
+Issues
+------
 
-## Available Scripts
+Feel free to submit issues and enhancement requests [here](https://github.com/Leapcode-Open/leapcode-frontend/issues)
 
-In the project directory, you can run:
+Please use [email protected] to report security vulnerabilities and severe bugs.
 
-### `yarn start`
+Contributing
+------------
 
-Runs the app in the development mode.<br />
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+Please refer to each project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.
 
-The page will reload if you make edits.<br />
-You will also see any lint errors in the console.
+ 1. **Fork** the repo on GitHub
+ 2. **Clone** the project to your own machine
+ 3. **Commit** changes to your own branch
+ 4. **Push** your work back up to your fork
+ 5. Submit a **Pull request** so that we can review your changes
 
-### `yarn test`
-
-Launches the test runner in the interactive watch mode.<br />
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `yarn build`
-
-Builds the app for production to the `build` folder.<br />
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.<br />
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+NOTE: Be sure to merge the latest from "upstream" before making a pull request!

README.md

@@ -1,11 +1,30 @@
-## Leapcode's Frontend Codebase
+## Leapcode's Frontend Codebase 
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
 
 Leapcode.io is an open source platform that motivates & rewards new open source contributors. Leapcode helps you contribute to open source projects right from your first pull request to working on major projects.
 
 ### How to signup & use?
 
 Visit [leapcode.io](https://leapcode.io) to signup & recieve access to the platform. Leapcode has a curated list of projects & resources to guide you with OS contribution.
 
+### Setting up the repo for development
+
+#### Setup
+```
+git clone https://github.com/Leapcode-Open/leapcode-frontend.git
+cd leapcode-frontend
+yarn install
+yarn start
+```
+
+#### Configs
+1. Rename env.example to .env 
+2. Download firebase service account json and add the details to .env
+
 ### Contributing
 
-We welcome contributions to the leapcode platform. Please see our contributing.md for detailed walkthrough.
+We welcome contributions to the leapcode platform. Read [CONTRIBUTING.MD](CONTRIBUTING.md) for guidelines on creating pull requests and reporting issues.
+
+### License
+
+All code within this repo is available under MIT License