docs: updating the README and Contributing Guide (#2207)

* docs: updating the README and Contributing Guide * fix: Bolded heading * fix: revise Aftan's last name Co-authored-by: Aftab Rehan <[email protected]> * fix: revise format for note Co-authored-by: Aftab Rehan <[email protected]> --------- Co-authored-by: Aftab Rehan <[email protected]>
rupali-codes · Dec 17, 2023 · ffa4d1c · ffa4d1c · vercel · Dec 17, 2023
1 parent b9aec54
commit ffa4d1c
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 7 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,12 +2,12 @@
 
 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**
 >
 > **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.**
-> 
+>
 > **An automated process has been implemented to ensure the timely management of Pull Requests (PRs) on this platform.**
-> 
+>
 > **PRs that have been open for a duration exceeding 45 days will be automatically closed, so please plan accordingly.**
 
 ## Prerequisites ⚠️
@@ -135,7 +135,16 @@ Follow these steps to setup LinksHub on your local machine
     > For example, if you export the subcategory name as `onlineCodeEditors` in `database/index.ts`, add the same name to `CategoryDescriptions.ts` using the following style:
     > `subcategory name:` `description of this subcategory`
 
-  - You can check out similar examples [here](components/TopBar/CategoryDescriptions.ts). It's essential to add a description when submitting a pull request to add a subcategory; to merge it in the codebase.
+  - Here's how it looks altogether:
+
+  ```ts
+  //category
+   subcategory name: 
+   `description of subcategory`,
+   ```
+
+> [!NOTE]  
+> It's essential to add a description when submitting a pull request to add a subcategory to merge it in the codebase.
 
 ---
 

diff --git a/README.md b/README.md
@@ -112,9 +112,10 @@ Need help while contributing? Tag any of the maintainers when creating the issue
 
 <table>
 <tr>
-<td align="center" width="200"><pre><a href="https://github.com/rupali-codes"><img src="https://avatars.githubusercontent.com/u/78981177?v=4" width="200" alt="GitHub Profile of Anmol Baranwal" /><br><sub>Rupali Haldiya</sub></a><br>@rupali-codes</pre></td>
-<td align="center" width="200"><pre><a href="https://github.com/CBID2"><img src="https://avatars.githubusercontent.com/u/105683440?v=4" width="200" alt="GitHub Profile of Anmol Baranwal" /><br><sub>Christine Belzie</sub></a><br>@CBID2</pre></td>
-<td align="center" width="200"><pre><a href="https://github.com/Anmol-Baranwal"><img src="https://avatars.githubusercontent.com/u/74038190?v=4" width="200" alt="GitHub Profile of Anmol Baranwal" /><br><sub>Anmol Baranwal</sub></a><br>@Anmol-Baranwal</pre></td>
+<td align="center" width="200"><pre><a href="https://github.com/rupali-codes"><img src="https://avatars.githubusercontent.com/u/78981177?v=4" width="200" alt="GitHub Profile picture of Rupali Haldiya" /><br><sub>Rupali Haldiya</sub></a><br>@rupali-codes</pre></td>
+<td align="center" width="200"><pre><a href="https://github.com/CBID2"><img src="https://avatars.githubusercontent.com/u/105683440?v=4" width="200" alt="GitHub Profile picture of Christine Belzie" /><br><sub>Christine Belzie</sub></a><br>@CBID2</pre></td>
+<td align="center" width="200"><pre><a href="https://github.com/Anmol-Baranwal"><img src="https://avatars.githubusercontent.com/u/74038190?v=4" width="200" alt="GitHub Profile picture of Anmol Baranwal" /><br><sub>Anmol Baranwal</sub></a><br>@Anmol-Baranwal</pre></td>
+<td align="center" width="200"><pre><a href="https://github.com/aftabrehan"><img src="https://avatars.githubusercontent.com/u/93012310?v=4" width="200" alt="GitHub Profile Picture of Aftab Rehan"/><br><sub>Aftab Rehan</sub></a><br>@aftabrehan</pre></td>
 
 </tr>
 </table>