diff --git a/README.md b/README.md index 42be580..2c24459 100644 --- a/README.md +++ b/README.md @@ -1,112 +1,135 @@ -
+ +
-## Table of Content ++ +
-- [Contributing](#contributing) -- [Contributors](#contributors) -- [License](#license) +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.
-Following are the steps to guide you: +## 📖 Table of Contents -### Step 1 +- [Contributing](#🤝-contributing) +- [Contributors](#✨-contributors) +- [Frontend Development](#🎨-frontend-development) +- [Guidelines](#📝-guidelines) +- [License](#📄-license) -- Fork this repository +## 🤝 Contributing -![fork](https://github.com/ArslanYM/StarterHive/assets/104521101/b2863384-753d-448b-9c8f-cc2122121c2b) +Follow these steps to contribute to the project: -### Step 2: +- ### Step 1 -- 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. + Fork this repository ++ +
-![clone](https://github.com/ArslanYM/StarterHive/assets/104521101/ffe2cb3b-d7e9-41fb-a7e6-8f5ca9d50dd0) +- ### 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. + ++ +
Open a terminal and run the following git command: -``` +```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. -![opy](https://github.com/ArslanYM/StarterHive/assets/104521101/5947298f-dd52-478c-9cd9-f22791eea4a5) ++ +
The code will look something like this : -``` +```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 -``` -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 ``` -- 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 ``` -### 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@@ -124,7 +147,8 @@ You can also contribute to this project if you are new to open source: |
@@ -154,34 +178,42 @@ You can also contribute to this project if you are new to open source: |
+ + + +
-## 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. +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 +## 📝 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! ✨ +