From ffa4d1cc08ee3ec633338c1fa531c012dc702575 Mon Sep 17 00:00:00 2001 From: Christine Belzie <105683440+CBID2@users.noreply.github.com> Date: Sun, 17 Dec 2023 10:23:24 -0500 Subject: [PATCH] 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 * fix: revise format for note Co-authored-by: Aftab Rehan --------- Co-authored-by: Aftab Rehan --- CONTRIBUTING.md | 17 +++++++++++++---- README.md | 7 ++++--- 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c2e6dbb4d..5109174a3 100644 --- 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 index acd0c7fe2..c74f94411 100644 --- a/README.md +++ b/README.md @@ -112,9 +112,10 @@ Need help while contributing? Tag any of the maintainers when creating the issue - - - + + + +
GitHub Profile of Anmol Baranwal
Rupali Haldiya
@rupali-codes
GitHub Profile of Anmol Baranwal
Christine Belzie
@CBID2
GitHub Profile of Anmol Baranwal
Anmol Baranwal
@Anmol-Baranwal
GitHub Profile picture of Rupali Haldiya
Rupali Haldiya
@rupali-codes
GitHub Profile picture of Christine Belzie
Christine Belzie
@CBID2
GitHub Profile picture of Anmol Baranwal
Anmol Baranwal
@Anmol-Baranwal
GitHub Profile Picture of Aftab Rehan
Aftab Rehan
@aftabrehan