chore: updated guidelines

CONTRIBUTING.md

@@ -2,42 +2,76 @@
 
 Thank you for taking the time to contribute to our project. Please take a moment to read the following guidelines before contributing:
 
-> IMPORTANT **Note**
+> ⚠️IMPORTANT **Note** 
 >
 > **Pull Requests having no issue associated with them will not be accepted. Firstly get an issue assigned, whether it's already opened or raised by you, and then create a Pull Request.**
 
 ## Prerequisites
 
 - Open Source Etiquette: If you've never contributed to an open source project before, have a read of [Basic etiquette](https://developer.mozilla.org/en-US/docs/MDN/Community/Open_source_etiquette) for open source projects.
+
 - Basic familiarity with Git and GitHub: If you are also new to these tools, visit [GitHub for complete beginners](https://developer.mozilla.org/en-US/docs/MDN/Contribute/GitHub_beginners) for a comprehensive introduction to them
+
 - [Node.js](https://nodejs.org/) is installed.
 
-## How to Contribute
+---
+## How to Contribute 🤔
 
 - Look at the existing [**Issues**](https://github.com/rupali-codes/LinksHub/issues) or [**create a new issue**](https://github.com/rupali-codes/LinksHub/issues/new/choose)!
 - [**Fork the Repo**](https://github.com/rupali-codes/LinksHub/fork). Then, create a branch for any issue that you are working on. Finally, commit your work.
 - Create a **[Pull Request](https://github.com/rupali-codes/LinksHub/compare)** (_PR_), which will be promptly reviewed and given suggestions for improvements by the community.
 - Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR.
 
-## Appending new Links
+### Appending new Links 🔗
+
+> ✨ You can also create [issue(s)](https://github.com/rupali-codes/LinksHub/issues/new/choose) for inserting your links and someone else will take care of them.
+
+#### 🌟Follow these steps to get your Links added into the Hub
+
+* A newly created category and subcategory should be added to the data file
+* Each category has it's own folder with it's name
+* Every subcategory should be placed in it respective category folder
+
+  > i.e images should be inside Frontend folder
+
+* To add a new category ensure to create a folder with it's name
+
+  > i.e Resources
+
+* Make sure to Export the newly created json file on the index file
+
+The subcategory object should follow this pattern
 
-- Go to `database/data.ts` create new object in the data array with the following pattern
   ```sh
-    id: +1 previous element,
-    name:'', //name of the site
-    description:'', //define what the site does in a short way
-    url:'', //add the valid site url
-    category:'', //can only be frontend or backend
-    subcategory:'' //what best describes the site. for example: images, fonts etc
+    id: '',
+    name:'', 
+    description:'',
+    url:'',
+    category:'', 
+    subcategory:''
   ```
 
-**Important!**
-
-- Do not make duplicate entries (always confirm that an entry does not exist by searching through the JSON file.
-- Ensure that your entries are error-free by double-checking before staging your changes.
-- Your entries should follow the above structure.
+  #### Details 
+
+  * `id`: +1 to it's previous element
+  * `name`: name of the site
+
+  * `description`: define what the site does in a 
+  short para
+
+  * `url`: add the valid site url
+  * `category`: could be one of the existing categories or create a new one by following the 
+  above instructions
+  * `subcategory`: could be one of the existing categories or create a new one by following the above instructions
+
+> **⚠️Important**
+>
+> - Do not make duplicate entries (always confirm that an entry does not exist by searching through the JSON file.
+> - Ensure that your entries are error-free by double-checking before staging your changes.
+> - Your entries should follow the above structure.
 
-## Making pull requests
+--- 
+## Making Pull Requests
 
 1. When you submit a pull request, several tests are automatically run
    as GitHub Actions. If any of these tests fail, it is your responsibility to try and resolve the underlying issue(s). If you don't know how to resolve the underlying issue(s), you can ask for help.
@@ -51,6 +85,7 @@ Thank you for taking the time to contribute to our project. Please take a moment
 6. Do not re-open a pull request that a reviewer has closed.
    - Make sure to tick the "Allow edits from maintainers" box. This allows us to directly make minor edits / refactors and saves a lot of time.
 
-## Remarks
+--- 
+## Remarks ✅
 
 If something is missing here, or you feel something is not well described, either directly create a PR or [create an issue](https://github.com/rupali-codes/LinksHub/issues).

README.md

@@ -18,43 +18,61 @@ You can see the live demo at: https://linkshub.vercel.app
 ![tailwind css](https://img.shields.io/badge/tailwind_css-7c3aed?style=for-the-badge&logo=tailwindcss&logoColor=white)
 ![typescript](https://img.shields.io/badge/typescript-7c3aed?style=for-the-badge&logo=typescript&logoColor=white)
 
+---
 ## Getting Started 👩‍💻
 
-> Prerequisites: Before getting into it make you sure, you have [npm](https://nodejs.org/download) installed
-
-Make sure to follow [CONTRIBUTING guidelines](https://github.com/rupali-codes/LinksHub/blob/main/CONTRIBUTING.md)
+> ⚠️Prerequisites
+> 
+> * Before getting into it make you sure you have [npm](https://nodejs.org/download) installed.
+> 
+> * Also make sure to follow [CONTRIBUTING guidelines](https://github.com/rupali-codes/LinksHub/blob/main/CONTRIBUTING.md)
 
-### Let's jump right in
-
-Follow these steps to start contributing into LinksHub
+### Let's jump right in🌟
 
 1. [Fork](https://github.com/rupali-codes/LinksHub/fork) the project
+
 2. Clone the project to run on your local machine using the following command
+
    ```sh
    git clone https://github.com/<your_github_username>/LinksHub.git
    ```
 3. Get into the root directory
+
    ```sh
    cd LinksHub
    ```
 4. Install all dependencies by running
+
    ```sh
    npm install
    ```
-5. Make your changes and push the code to your Github repo
-6. Now, create a pull request
 
-Bingo! You're done
+5. Create your branch 
+    ```sh
+   git checkout -b <your_branch_name>
+   ```
+6. Push your changes into your branch
+
+    ```sh
+   git push origin <your_branch_name>
+   ```
+
+7. Create a [Pull Request](https://github.com/rupali-codes/LinksHub/compare) 
+   > Click _compare acorss forks_ if you don't see your branch 
+
 
-### Building with Gitpod 💣
+
+### _Want to add your favorite Links into the Hub? Read the instructions [here](https://github.com/rupali-codes/LinksHub/blob/main/database/Readme.md) and follow [CONTRIBUTING guidelines](https://github.com/rupali-codes/LinksHub/blob/main/CONTRIBUTING.md)._
+
+---
+## Building with Gitpod 💣
 
 By using [Gitpod.io](https://www.gitpod.io), all the necessary dependencies will be installed\
 and the website will be built in one single click. No extra setup is required.
 
 [![Gitpod Ready-to-Code](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/rupali-codes/LinksHub)
 
-> Want to add your favorite Links into the Hub? Read the instructions [here](https://github.com/rupali-codes/LinksHub/blob/main/database/Readme.md).
-
+---
 
 ## Our Contributors ✨
 
@@ -66,6 +84,5 @@ and the website will be built in one single click. No extra setup is required.
 
 LinksHub is licensed under the terms of MIT License. check out [LICENSE](https://github.com/rupali-codes/LinksHub/blob/main/LICENSE) for details.
 
----
 
-We would love to have you, feel free to open issues and pull requests and Don't forget to leave a star⭐
+_We would love to have you, feel free to open issues and pull requests and Don't forget to leave a star⭐_