add contributing guidelines and update readme

Signed-off-by: Aman Dwivedi <[email protected]>

Author: Aman-Codes

CONTRIBUTION.md

@@ -0,0 +1,36 @@
+# STEPS TO CONTRIBUTE
+
+1. Find an issue to work on or create a new issue at [https://github.com/litmuschaos/litmus-e2e/issues](https://github.com/litmuschaos/litmus-e2e/issues) if you find a bug/suggest a new feature addition/change.
+
+2. Fork the main repository to create a duplicate copy for yourself.
+
+3. Clone the `gh-pages` branch of `litmus-e2e` repository
+```
+  git clone -b gh-pages https://github.com/litmuschaos/litmus-e2e.git
+```
+
+4. Create a feature branch in the forked repository and always send a PR from the feature-branch to the `gh-pages` branch of the upstream repository.
+
+```
+  Example- Aman-Codes/modal-component -> litmus-e2e/gh-pages
+```
+
+## PULL REQUEST SPECIFICATIONS
+
+To ensure that your PR is of high quality and to maintain the coding standards there are some best practices which we need to adhere to in order to successfully merge the PRs.
+
+1. While committing the changes please ensure you sign your commits by using -s flag
+```
+  git commit -s -m “<YOUR COMMIT MESSAGE>”
+```
+
+2. Please fill in the details of the changes that have been made/modified with the respective PR and also check of the necessary checklist in the PR checklist itself.
+
+3. Always lint your project locally before sending a PR.
+```
+  yarn run format
+```
+
+4. Don’t skip husky pre-commit checks as it ensures your code is well formatted and linted as well. Please don’t bypass husky since non-formatted code are very easy to detect.
+
+5. Keep the main repository as an upstream in order to always fetch from the main repository and keep your local branch as updated as possible to not hinder your work.

README.md

@@ -1,70 +1,47 @@
-# Getting Started with Create React App
+# Litmus E2E Dashboard
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+## Prerequisites
 
-## Available Scripts
+- Install Yarn globally
 
-In the project directory, you can run:
+## Setup and Installation
 
-### `yarn start`
+- Clone the `gh-pages` branch of `litmus-e2e` repository
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+```
+  git clone -b https://github.com/litmuschaos/litmus-e2e.git
+```
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+- Install all the required dependencies with the below command
 
-### `yarn test`
+```
+  yarn install
+```
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+## Run locally
 
-### `yarn build`
+Run the below command to start the server:
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+```
+  yarn start
+```
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
+Go to: http://localhost:3000/litmus-e2e/dashboard
+## Deployed Link
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+Visit the deployed website at https://litmuschaos.github.io/litmus-e2e/dashboard/
 
-### `yarn eject`
+## Tech Stack
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+Litmus E2E Dashboard is built using the following:
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+- JavaScript
+- Prettier
+- ESLint
+- Husky
+- Litmus UI
+- Material UI
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+## Contribution Guidelines
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
-
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `yarn build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
+Check our official [contribution guidelines](https://github.com/litmuschaos/litmus-e2e/blob/gh-pages/CONTRIBUTION.md).