From c049c8564840be9db19c8faeb02382deb71b66f1 Mon Sep 17 00:00:00 2001 From: amarealcoder Date: Thu, 17 Nov 2022 09:28:48 +0100 Subject: [PATCH 1/3] Feat: Adds contributing guides to readme.md file --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 61b1eb6d..6dd9b962 100644 --- a/README.md +++ b/README.md @@ -1 +1,32 @@ -# salesaccount.web \ No newline at end of file +# salesaccount.web + +## Contributing + +Contributions are always welcome! + +Please adhere to this project's `code of conduct`. + +Before you contribute, please read through this document. + +1. Change your repo's branch to dev by checking the `dev branch box`. + +2. Clone this repo using: `git clone https://github.com/workshopapps/salesaccount.web.git`. + +3. Change directory into the frontend directory using: `cd frontend`. + +4. Install dependencies using: `npm install`. + +5. Checkout to dev branch using: `git checkout dev`. + +6. Create your feature branch by running `git checkout -b BRANCH_NAME`. Please do not work from the `main branch`. + + +Work, add files and make commits. + +7. After working on your feature use `git add .` to add your changes. + +8. Add a commit message using: `git commit -m YOUR_MESSAGE`. Make the message descriptive. + +9. Push your work using: `git push origin BRANCH_NAME` + +10. Open the project GitHub page. You'll see an alert asking you to compare and make a PR. Fill the necessary information and make a PR. \ No newline at end of file From 805dcf8c590a4368073c2b019e8be4203c787372 Mon Sep 17 00:00:00 2001 From: amarealcoder Date: Thu, 17 Nov 2022 09:34:18 +0100 Subject: [PATCH 2/3] Feat: Adds contributing guides to readme.md file --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 6dd9b962..07e5f023 100644 --- a/README.md +++ b/README.md @@ -8,25 +8,23 @@ Please adhere to this project's `code of conduct`. Before you contribute, please read through this document. -1. Change your repo's branch to dev by checking the `dev branch box`. +1. Clone this repo using: `git clone https://github.com/workshopapps/salesaccount.web.git`. -2. Clone this repo using: `git clone https://github.com/workshopapps/salesaccount.web.git`. +2. Change directory into the frontend directory using: `cd frontend`. -3. Change directory into the frontend directory using: `cd frontend`. +3. Install dependencies using: `npm install`. -4. Install dependencies using: `npm install`. +4. Checkout to dev branch using: `git checkout dev`. -5. Checkout to dev branch using: `git checkout dev`. - -6. Create your feature branch by running `git checkout -b BRANCH_NAME`. Please do not work from the `main branch`. +5. Create your feature branch by running `git checkout -b BRANCH_NAME`. Please do not work from the `main branch`. Work, add files and make commits. -7. After working on your feature use `git add .` to add your changes. +6. After working on your feature use `git add .` to add your changes. -8. Add a commit message using: `git commit -m YOUR_MESSAGE`. Make the message descriptive. +7. Add a commit message using: `git commit -m YOUR_MESSAGE`. Make the message descriptive. -9. Push your work using: `git push origin BRANCH_NAME` +8. Push your work using: `git push origin BRANCH_NAME` -10. Open the project GitHub page. You'll see an alert asking you to compare and make a PR. Fill the necessary information and make a PR. \ No newline at end of file +9. Open the project GitHub page. You'll see an alert asking you to compare and make a PR. Change the base branch to dev and make a PR. \ No newline at end of file From b963b447761406fb75399c92b54a189b69d7712a Mon Sep 17 00:00:00 2001 From: Miracle Ugorji Date: Sat, 19 Nov 2022 12:06:35 +0100 Subject: [PATCH 3/3] Feat: Correction in the readme file --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 07e5f023..c78b5ee0 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ Contributions are always welcome! -Please adhere to this project's `code of conduct`. Before you contribute, please read through this document.