From 075aaaebecbcdc6188ad5000b9baf8d1a83e7493 Mon Sep 17 00:00:00 2001 From: Sean Date: Sun, 23 Oct 2022 16:20:42 +0800 Subject: [PATCH] Fixed spelling error in contributing.md and updated pull request section (#41) --- contributing.md | 35 ++++++++++++++++++++++------------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/contributing.md b/contributing.md index 6cf16f47a..d0a701def 100644 --- a/contributing.md +++ b/contributing.md @@ -1,28 +1,31 @@ ## Lets make bruno better, together !! -I am happy that you are looking to improve bruno. Below are the guidelines to get started bringing up bruno on your computed. + +I am happy that you are looking to improve bruno. Below are the guidelines to get started bringing up bruno on your computer. ### Technology Stack + Bruno is built using NextJs and React. We also use electron to ship a desktop version (that supports local collections) -Libraries we use -* CSS - Tailwind -* Code Editors - Codemirror -* State Management - Redux -* Icons - Tabler Icons -* Forms - formik -* Schema Validation - Yup -* Request Client - axios -* Filesystem Watcher - chokidar +Libraries we use +- CSS - Tailwind +- Code Editors - Codemirror +- State Management - Redux +- Icons - Tabler Icons +- Forms - formik +- Schema Validation - Yup +- Request Client - axios +- Filesystem Watcher - chokidar ### Dependencies -You would need Node v14.x and npm 8.x. We use npm workspaces in the project + +You would need [Node v14.x or the latest LTS version](https://nodejs.org/en/) and npm 8.x. We use npm workspaces in the project ### Lets start coding ```bash # clone and cd into bruno -# use Node 14.x, Npm 8.x +# use Node 14.x, Npm 8.x # Install deps (note that we use npm workspaces) npm i @@ -41,4 +44,10 @@ open http://localhost:3000 ``` ### Raising Pull Request -* Please keep the PR's small and focused on one thing + +- Please keep the PR's small and focused on one thing +- Please follow the format of creating branches + - feature/[feature name]: This branch should contain changes for a specific feature + - Example: feature/dark-mode + - bugfix/[bug name]: This branch should container only bug fixes for a specific bug + - Example bugfix/bug-1