From b4646179a324984be91baefc275d2cea6dd9abef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9C=5BMartialeagle?= Date: Wed, 31 May 2023 16:25:43 +0530 Subject: [PATCH 1/6] added emojis and changed alignment --- README.md | 167 +++++++++++++++++++++++++----------------------------- 1 file changed, 76 insertions(+), 91 deletions(-) diff --git a/README.md b/README.md index 42be580..5d100a2 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,26 @@ -

Starter Hive ✨

-

This project aims to simplify and guide the way beginners make their first contribution.

+

Starter Hive ✨

-![github-header](https://github.com/ArslanYM/StarterHive/assets/104521101/df4450df-4c47-475c-b369-53353c8ce17f) +

+ License +

-## Table of Content +

+ GitHub Header +

-- [Contributing](#contributing) -- [Contributors](#contributors) -- [License](#license) +

🚀 Simplifying and Guiding First Contributions for Beginners 🚀

-## Contributing +Welcome to Starter Hive! This project is designed to make it easier for beginners to get started with their first contribution. Whether you're new to programming or looking to contribute to open-source projects, this repository provides the resources and guidance you need. + +## 📖 Table of Contents + +- [Contributing](#🤝-contributing) +- [Contributors](#✨-contributors) +- [Frontend Development](#🎨-frontend-development) +- [Guidelines](#📝-guidelines) +- [License](#📄-license) + +## 🤝 Contributing Following are the steps to guide you: @@ -27,7 +38,7 @@ Following are the steps to guide you: Open a terminal and run the following git command: -``` +```bash git clone "url you just copied" ``` @@ -37,7 +48,7 @@ where "url you just copied" (without the quotation marks) is the url to this rep The code will look something like this : -``` +```bash git clone https://github.com/{your user name}/StarterHive.git ``` @@ -45,7 +56,7 @@ git clone https://github.com/{your user name}/StarterHive.git - Navigate to StarterHive on your device -``` +```bash cd StaterHive/ ``` @@ -53,118 +64,86 @@ cd StaterHive/ - Add an upstream link to the main branch in your cloned repo - ``` - git remote add upstream https://github.com/ArslanYM/StarterHive - ``` +```bash +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) - ``` - git pull upstream main - ``` + +```bash +git pull upstream main +``` ### Step 5: - Create your feature branch (This is a necessary step, so don't skip it) - ``` - git checkout -b - ``` + +```bash +git checkout -b +``` ### Step 6: Make necessary changes and commit those changes - Add your commits to the staging - ``` - git add . - ``` + +``` +git add . +``` ### Step 7: Commit the changes - Now commit those changes using the `git commit` command: - ``` - git commit -m "Write a meaningful but small commit message" - ``` + +```bash +git commit -m "Write a meaningful but small commit message" +``` + - Follow this [Guide](https://gist.github.com/tonibardina/9290fbc7d605b4f86919426e614fe692) for commit messages. ### Step 8: Push your code. - Push your changes using the command `git push` : - ``` - git push -u origin your-branch-name - ``` + +```bash +git push -u origin your-branch-name +``` ### Step 9: - 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) -
- +
+ New to open-source? - + You can also contribute to this project if you are new to open source: - [Check out the `CONTRIBUTORS.md` file to get started](CONTRIBUTORS.md) -
- -

Project Admin

- - - - -
- - Arsalan -
- - - Arslan Malik - - - -
-
- -

Project Mentors

- - - - - -
- - Nadeem -
- - - Nadeem - - - -
- 		- - Rahil -
- - - Rahil Ansari - - - -
-
- -## Contributors - -Thank you for your dedication and hard work. Your contributions are invaluable to our team, and we are so grateful for all that you do. Your hard work and dedication is truly admirable. Thank you for your unwavering commitment and for all that you do for our team. +
+ +## 🧑‍💼 Project Admin + +| Arsalan Malik
Arsalan Malik | +| :------------------------------------------------------------------------------------------------------------------------------------------------------------: | + +## 👥 Project Mentors + +| Nadeem
Nadeem | Rahil Ansari
Rahil Ansari | +| :------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------: | + +## ✨ Contributors + +Thank you for your dedication and hard work. Your contributions are invaluable to our team, and we are so grateful for all that you do. Your hard work and dedication are truly admirable. Thank you for your unwavering commitment and for all that you do for our team. Please visit [Contributors](/CONTRIBUTORS.md) to check the list of contributors and add your name to the list to become a contributor. - +Contributors -## Frontend Development +## 🎨 Frontend Development Calling all frontend developers! We invite you to contribute to the `web/` directory of this project. The `web/` directory contains all the frontend code and assets. Whether you're experienced or just starting with frontend development, your contributions are highly appreciated. @@ -178,10 +157,16 @@ To contribute to the frontend development: Let's work together to create an amazing frontend experience for our users! -## Guidelines +## 📝 Guidelines + +Please ensure that you adhere to the project's guidelines while making contributions. You can find detailed guidelines in the [Guidelines](GUIDELINES.md) document. + +## 📄 License -Make sure you are following the Guidelines of this project while contributing. Take a look at [Guidelines](GUIDELINES.md). +Starter Hive is licensed under the MIT License. For more information, please see the [LICENSE](https://github.com/ArslanYM/StarterHive/blob/main/LICENSE) file. -## License +--- -Starter Hive is licensed under the MIT License. See the [LICENSE](https://github.com/ArslanYM/StarterHive/blob/main/LICENSE) file for more information. +

+Thank you for choosing Starter Hive! We hope this repository helps you in your journey as an open-source contributor. Let's create amazing things together! ✨ +

From 440dd8ec22b6914a964f97a82f331d574ad2cb9e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9C=5BMartialeagle?= Date: Wed, 31 May 2023 16:44:57 +0530 Subject: [PATCH 2/6] Refactor main Readme for better organization and aesthetics --- README.md | 138 +++++++++++++++++++++++++++--------------------------- 1 file changed, 70 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index 5d100a2..0ade87a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -

Starter Hive ✨

+

Starter Hive ✨

License @@ -8,9 +8,9 @@ GitHub Header

-

🚀 Simplifying and Guiding First Contributions for Beginners 🚀

+

🚀 Simplifying and Guiding First Contributions for Beginners 🚀

-Welcome to Starter Hive! This project is designed to make it easier for beginners to get started with their first contribution. Whether you're new to programming or looking to contribute to open-source projects, this repository provides the resources and guidance you need. +

Welcome to Starter Hive! This project aims to make it easier for beginners to make their first contributions. Whether you're new to programming or looking to contribute to open-source projects, this repository provides the necessary resources and guidance.

## 📖 Table of Contents @@ -22,99 +22,99 @@ Welcome to Starter Hive! This project is designed to make it easier for beginner ## 🤝 Contributing -Following are the steps to guide you: +Follow these steps to contribute to the project: -### Step 1 +- ### Step 1 -- Fork this repository + Fork this repository -![fork](https://github.com/ArslanYM/StarterHive/assets/104521101/b2863384-753d-448b-9c8f-cc2122121c2b) + ![fork](https://github.com/ArslanYM/StarterHive/assets/104521101/b2863384-753d-448b-9c8f-cc2122121c2b) -### Step 2: +- ### Step 2: -- Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon. + Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon. -![clone](https://github.com/ArslanYM/StarterHive/assets/104521101/ffe2cb3b-d7e9-41fb-a7e6-8f5ca9d50dd0) + ![clone](https://github.com/ArslanYM/StarterHive/assets/104521101/ffe2cb3b-d7e9-41fb-a7e6-8f5ca9d50dd0) -Open a terminal and run the following git command: + Open a terminal and run the following git command: -```bash -git clone "url you just copied" -``` + ```bash + git clone "url you just copied" + ``` -where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url. + where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url. -![opy](https://github.com/ArslanYM/StarterHive/assets/104521101/5947298f-dd52-478c-9cd9-f22791eea4a5) + ![opy](https://github.com/ArslanYM/StarterHive/assets/104521101/5947298f-dd52-478c-9cd9-f22791eea4a5) -The code will look something like this : + The code will look something like this : -```bash -git clone https://github.com/{your user name}/StarterHive.git -``` + ```bash + git clone https://github.com/{your user name}/StarterHive.git + ``` -### Step 3: +- ### Step 3: -- Navigate to StarterHive on your device + Navigate to StarterHive on your device -```bash -cd StaterHive/ -``` + ```bash + cd StaterHive/ + ``` -### Step 4: +- ### Step 4: -- Add an upstream link to the main branch in your cloned repo + - Add an upstream link to the main branch in your cloned repo -```bash -git remote add upstream https://github.com/ArslanYM/StarterHive -``` + ```bash + 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) + - Keep your cloned repo up to date by pulling from upstream (this will also avoid any merge conflicts while committing new changes) -```bash -git pull upstream main -``` + ```bash + git pull upstream main + ``` -### Step 5: +- ### Step 5: -- Create your feature branch (This is a necessary step, so don't skip it) + Create your feature branch (This is a necessary step, so don't skip it) -```bash -git checkout -b -``` + ```bash + git checkout -b + ``` -### Step 6: Make necessary changes and commit those changes +- ### Step 6: Make necessary changes and commit those changes -- Add your commits to the staging + Add your commits to the staging -``` -git add . -``` + ``` + git add . + ``` -### Step 7: Commit the changes +- ### Step 7: Commit the changes -- Now commit those changes using the `git commit` command: + - Now commit those changes using the `git commit` command: -```bash -git commit -m "Write a meaningful but small commit message" -``` + ```bash + git commit -m "Write a meaningful but small commit message" + ``` -- Follow this [Guide](https://gist.github.com/tonibardina/9290fbc7d605b4f86919426e614fe692) for commit messages. + - Follow this [Guide](https://gist.github.com/tonibardina/9290fbc7d605b4f86919426e614fe692) for commit messages. -### Step 8: Push your code. +- ### Step 8: Push your code. -- Push your changes using the command `git push` : + Push your changes using the command `git push` : -```bash -git push -u origin your-branch-name -``` + ```bash + git push -u origin your-branch-name + ``` -### Step 9: +- ### Step 9: -- 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) + 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)
- New to open-source? + New to open-source? You can also contribute to this project if you are new to open source: @@ -135,38 +135,40 @@ You can also contribute to this project if you are new to open source: ## ✨ Contributors -Thank you for your dedication and hard work. Your contributions are invaluable to our team, and we are so grateful for all that you do. Your hard work and dedication are truly admirable. Thank you for your unwavering commitment and for all that you do for our team. +Thank you for your dedication and hard work. Your contributions are invaluable to our team, and we are so grateful for all that you do. Your hard work and dedication are truly admirable. Thank you for your unwavering commitment and for all that you do for our team. Please visit [Contributors](/CONTRIBUTORS.md) to check the list of contributors and add your name to the list to become a contributor. - -Contributors - +

+ + Contributors + +

## 🎨 Frontend Development -Calling all frontend developers! We invite you to contribute to the `web/` directory of this project. The `web/` directory contains all the frontend code and assets. Whether you're experienced or just starting with frontend development, your contributions are highly appreciated. +Calling all frontend developers! We invite you to contribute to the `web/` directory of this project. The `web/` directory contains all the frontend code and assets. Whether you're experienced or just starting with frontend development, your contributions are highly appreciated. Feel free to explore the `web/` directory, make improvements, fix bugs, or add new features. Don't hesitate to share your ideas and suggestions to enhance the user experience. To contribute to the frontend development: -1. Fork this repository. +1. Fork this repository. 2. Make your changes in the `web/` directory. -3. Submit a pull request explaining the changes you made and why they are valuable. +3. Submit a pull request explaining the changes you made and why they are valuable. Let's work together to create an amazing frontend experience for our users! ## 📝 Guidelines -Please ensure that you adhere to the project's guidelines while making contributions. You can find detailed guidelines in the [Guidelines](GUIDELINES.md) document. +Please ensure that you adhere to the project's guidelines while making contributions. You can find detailed guidelines in the [Guidelines](GUIDELINES.md) document. ## 📄 License -Starter Hive is licensed under the MIT License. For more information, please see the [LICENSE](https://github.com/ArslanYM/StarterHive/blob/main/LICENSE) file. +Starter Hive is licensed under the MIT License. For more information, please see the [LICENSE](https://github.com/ArslanYM/StarterHive/blob/main/LICENSE) file. ---

-Thank you for choosing Starter Hive! We hope this repository helps you in your journey as an open-source contributor. Let's create amazing things together! ✨ + Thank you for choosing Starter Hive! We hope this repository helps you in your journey as an open-source contributor. Let's create amazing things together! ✨

From 51eac32b42cdb1cadc12be1c0a75dd924acdfa19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9C=5BMartialeagle?= Date: Wed, 31 May 2023 16:51:07 +0530 Subject: [PATCH 3/6] Refactor main Readme for better organization and aesthetic looks --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 44 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0ade87a..0d0e379 100644 --- a/README.md +++ b/README.md @@ -125,14 +125,53 @@ You can also contribute to this project if you are new to open source: ## 🧑‍💼 Project Admin -| Arsalan Malik
Arsalan Malik | -| :------------------------------------------------------------------------------------------------------------------------------------------------------------: | + + + + +
+ + Arsalan +
+ + + Arslan Malik + + + +
+
## 👥 Project Mentors -| Nadeem
Nadeem | Rahil Ansari
Rahil Ansari | -| :------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------: | - + + + + + +
+ + Nadeem +
+ + + Nadeem + + + +
+ 		+ + Rahil +
+ + + Rahil Ansari + + + +
+
## ✨ Contributors Thank you for your dedication and hard work. Your contributions are invaluable to our team, and we are so grateful for all that you do. Your hard work and dedication are truly admirable. Thank you for your unwavering commitment and for all that you do for our team. From c4fd85a577b494164fe0953a4f8b6245fcc24688 Mon Sep 17 00:00:00 2001 From: Ashwanthram K L <71945723+AshwanthramKL@users.noreply.github.com> Date: Wed, 31 May 2023 16:52:13 +0530 Subject: [PATCH 4/6] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0d0e379..257df4f 100644 --- a/README.md +++ b/README.md @@ -172,6 +172,7 @@ You can also contribute to this project if you are new to open source: + ## ✨ Contributors Thank you for your dedication and hard work. Your contributions are invaluable to our team, and we are so grateful for all that you do. Your hard work and dedication are truly admirable. Thank you for your unwavering commitment and for all that you do for our team. From f74c539d714025dda8149b312fdb848530eaff3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9C=5BMartialeagle?= Date: Wed, 31 May 2023 16:56:07 +0530 Subject: [PATCH 5/6] center aligned images --- README.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 0d0e379..0d9b60c 100644 --- a/README.md +++ b/README.md @@ -27,30 +27,35 @@ Follow these steps to contribute to the project: - ### Step 1 Fork this repository - - ![fork](https://github.com/ArslanYM/StarterHive/assets/104521101/b2863384-753d-448b-9c8f-cc2122121c2b) +
+ fork +
- ### Step 2: Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon. - ![clone](https://github.com/ArslanYM/StarterHive/assets/104521101/ffe2cb3b-d7e9-41fb-a7e6-8f5ca9d50dd0) +

+ clone +

- Open a terminal and run the following git command: +Open a terminal and run the following git command: - ```bash - git clone "url you just copied" - ``` +```bash +git clone "url you just copied" +``` - where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url. +where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url. - ![opy](https://github.com/ArslanYM/StarterHive/assets/104521101/5947298f-dd52-478c-9cd9-f22791eea4a5) +

+ opy +

- The code will look something like this : +The code will look something like this : - ```bash - git clone https://github.com/{your user name}/StarterHive.git - ``` +```bash +git clone https://github.com/{your user name}/StarterHive.git +``` - ### Step 3: From a645efc3ba3cd5aabca8375482578644632ab294 Mon Sep 17 00:00:00 2001 From: Ashwanthram K L <71945723+AshwanthramKL@users.noreply.github.com> Date: Wed, 31 May 2023 16:58:19 +0530 Subject: [PATCH 6/6] centered images --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 86ad144..2c24459 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,9 @@ Follow these steps to contribute to the project: - ### Step 1 Fork this repository -
- fork -
+

+ fork +

- ### Step 2: