From 3363357b9df9a733e5a53969a9d76b85e0d34b4d Mon Sep 17 00:00:00 2001 From: Nikhil Nandagopal Date: Thu, 17 Sep 2020 21:24:35 +0530 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 17e6fb08e5..3cfec62168 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,10 +5,11 @@ Appsmith is a project by developers for developers and there are a lot of ways y Feel free to propose changes to this document in a pull request. ### Table of contents -- [Code of conduct](CODE_OF_CONDUCT.md) -- [How can I contribute?](#how-can-i-contribute) -- [How to set up local development?](#how-to-set-up-local-development) -- [How to run tests?](#how-to-run-tests) +- Code of conduct +- How can I contribute? +- Git Workflow +- Setting up local development +- Running tests ## How can I contribute? There are many ways in which we/one can to contribute to Appsmith. All contributions are highly appreciated. @@ -20,6 +21,10 @@ There are many ways in which we/one can to contribute to Appsmith. All contribut - Introduce New Widgets - Introduce New Database Integrations - Introduce New SAAS Integrations + +## Code of conduct + +Read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing ## Git Workflow @@ -34,7 +39,7 @@ Pull requests are the best way to propose changes to the codebase and get them r 5. Create an issue referencing the pull request. This ensures that we can track the bug being fixed or feature being added easily. -## ๐Ÿ‘จโ€๐Ÿ’ป How to set up local development +## ๐Ÿ‘จโ€๐Ÿ’ป Setting up local development ### Client Appsmith's client (UI/frontend) uses the ReactJS library and Typescript. The application also uses libraries like react-redux and redux-saga for workflows. @@ -109,7 +114,7 @@ echo "127.0.0.1 dev.appsmith.com" | sudo tee -a /etc/hosts cp envs/dev.env.example envs/dev.env ``` -## ๐Ÿงช How to run tests +## ๐Ÿงช Running tests ##### Client 1. In order to run the Cypress integration tests, run: