From b1350862fef5e59affa701c8e3f4c909c283ebd2 Mon Sep 17 00:00:00 2001 From: Ramya S <73107747+ramya202000@users.noreply.github.com> Date: Wed, 9 Aug 2023 20:20:03 +0530 Subject: [PATCH 1/3] Added some steps to help the beginners --- web/src/pages/Docs/Guide.jsx | 63 +++++++++++++++++++++++++----------- 1 file changed, 44 insertions(+), 19 deletions(-) diff --git a/web/src/pages/Docs/Guide.jsx b/web/src/pages/Docs/Guide.jsx index aa6aa25..7a931d6 100644 --- a/web/src/pages/Docs/Guide.jsx +++ b/web/src/pages/Docs/Guide.jsx @@ -17,7 +17,7 @@ const Guide = () => { Getting started 🗺️ -

+

This guide will help you to make your first contribution{" "}

{/* Step 1 */} @@ -40,16 +40,16 @@ const Guide = () => { Step 2: Clone the forked repository -

+

Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

-

+

Open a terminal and run the following git command:

git clone <URL you just copied> -

+

The code will look something like this :

@@ -76,17 +76,42 @@ const Guide = () => { {/* Step 4 */} +
+

+ Step 4: Install Dependices +

+

+ Move to source directory by typing the comment below. +

+ + cd web/src +

+ You need to install dependices used for this project. It will download all the necessary dependices automatically. +

+ npm install +
+ {/* Step 5 */} + +
+

+ Step 3: To run app +

+ + npm run dev --host +
+ + {/* Step 6 */}

- Step 4: Add an upstream link to the main branch in your cloned repo + Step 6: Add an upstream link to the main branch in your cloned repo

git remote add upstream https://github.com/ArslanYM/StarterHive -

+

Keep your cloned repo up to date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)

@@ -94,37 +119,37 @@ const Guide = () => { git pull upstream main
- {/* Step 5 */} + {/* Step 7 */}

- Step 5: Create your feature branch (Required) + Step 7: Create your feature branch (Required)

git checkout -b <feature-name>
- {/* Step 6 */} + {/* Step 8 */}

- Step 6: Make necessary changes + Step 8: Make necessary changes

-

+

Add your commits to the staging

git add .
- {/* Step 7 */} + {/* Step 9 */}

- Step 7: Commit the changes + Step 9: Commit the changes

-

+

commit those changes using the `git commit` command:

@@ -133,7 +158,7 @@ const Guide = () => {
- {/* step 8 */} + {/* step 10 */}

@@ -143,21 +168,21 @@ const Guide = () => { git push -u origin your-branch-name

- {/* Step 9 */} + {/* Step 11 */}

Step 9: Create a PR on Github

-

+

Create a PR on Github. (Don't just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing)

-

+

Make sure you are following the Guidelines of this project while contributing. Take a look at{" "} { ); }; -export default Guide; +export default Guide; \ No newline at end of file From b2a0e0e1bb9dfb7381fde111e6bcca57e91ba590 Mon Sep 17 00:00:00 2001 From: Ramya S <73107747+ramya202000@users.noreply.github.com> Date: Wed, 9 Aug 2023 20:23:35 +0530 Subject: [PATCH 2/3] changed the step numbers --- web/src/pages/Docs/Guide.jsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/src/pages/Docs/Guide.jsx b/web/src/pages/Docs/Guide.jsx index 7a931d6..3dd5c5f 100644 --- a/web/src/pages/Docs/Guide.jsx +++ b/web/src/pages/Docs/Guide.jsx @@ -94,7 +94,7 @@ const Guide = () => {

- Step 3: To run app + Step 5: To run app

npm run dev --host @@ -162,7 +162,7 @@ const Guide = () => {

- Step 8: Push your code + Step 10: Push your code

git push -u origin your-branch-name From 3e63ebe1338f7141b54f7c7a9e0ae725d4280d81 Mon Sep 17 00:00:00 2001 From: Ramya S <73107747+ramya202000@users.noreply.github.com> Date: Sun, 13 Aug 2023 18:22:35 +0530 Subject: [PATCH 3/3] corrected spelling mistakes --- web/src/pages/Docs/Guide.jsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/src/pages/Docs/Guide.jsx b/web/src/pages/Docs/Guide.jsx index 3dd5c5f..3dc5873 100644 --- a/web/src/pages/Docs/Guide.jsx +++ b/web/src/pages/Docs/Guide.jsx @@ -78,7 +78,7 @@ const Guide = () => { {/* Step 4 */}

- Step 4: Install Dependices + Step 4: Install dependencies

Move to source directory by typing the comment below. @@ -86,7 +86,7 @@ const Guide = () => { cd web/src

- You need to install dependices used for this project. It will download all the necessary dependices automatically. + You need to install dependencies used for this project. It will download all the necessary dependices automatically.

npm install