From 57a3b97f0c1b00a5d7ef8d42b25ce30a417f1c4d Mon Sep 17 00:00:00 2001 From: Abhisar Yadav <112550486+abhisar-yadav@users.noreply.github.com> Date: Thu, 10 Aug 2023 17:52:08 +0530 Subject: [PATCH 1/4] Update CONTRIBUTING.md CORRECTED GRAMMATICAL ERRORS IN CONTRIBUTING PAGE --- CONTRIBUTING.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a95594ca..10667f5da 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,7 +41,7 @@ Thank you for taking the time to contribute to our project. Please take a moment > For example, create a folder named `Resources` -- If you want to add a new subcategory, add it in [data.ts](https://github.com/rupali-codes/LinksHub/blob/main/database/data.ts) under the correct category, and provide the appropriate `url`. You can refer to the examples in the file. +- If you want to add a new subcategory, add it in [data.ts](https://github.com/rupali-codes/LinksHub/blob/main/database/data.ts) under the correct category, and provide the appropriate `URL`. You can refer to the examples in the file. - Make sure to export the newly created JSON file in the index file. @@ -61,7 +61,7 @@ Thank you for taking the time to contribute to our project. Please take a moment > 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: - > subcategoryName: 'description of this subcategory' + > 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. @@ -91,16 +91,16 @@ Thank you for taking the time to contribute to our project. Please take a moment - `name`: Name of the site - - `description`: A brief description of what the site does - - `url`: Add a valid URL of the site - - `category`: Choose an existing category or create a new one following the instructions mentioned above. + - `Description`: A brief description of what the site does + - `URL`: Add a valid URL of the site + - `Category`: Choose an existing category or create a new one following the instructions mentioned above. - `subcategory`: Choose an existing subcategory or create a new one following the instructions mentioned above. - `language`: This field is included for some of the resources, such as _React_ resources or _YouTube_ channel links. If multiple languages are involved, prioritize English if available. Otherwise, choose a language that you deem necessary. - You can use [JSONLint](https://jsonlint.com/) to check the correctness of the JSON to avoid failing tests during pull requests. **NOTE** -When adding _YouTube_ channel link, please specify _the language_ of the channel they are using to teach for example English, Hindi, Spanish etc. In cases where the language is NOT specified, then just remove the `language` property. +When adding _YouTube_ channel link, please specify _the language_ of the channel they are using to teach for example English, Hindi, Spanish, etc. In cases where the language is NOT specified, then just remove the `language` property. > **⚠️Important** > @@ -203,12 +203,12 @@ We follow a standardized commit message format using Commitlint to ensure consis #### Valid Commit Messages: - `feat: Add user authentication feature` -- `fix(auth): Resolve login page redirect issue` -- `docs: Update installation instructions` -- `style: Format code according to project guidelines` +- `fix(auth): Resolve login page redirect issue +- `docs: Update installation instructions +- `style: Format code according to project guidelines - `refactor(navbar): Improve responsiveness` - `test: Add unit tests for API endpoints` -- `chore: Update dependencies to latest versions` +- `chore: Update dependencies to latest versions - `fix: Handle edge case in data processing (#456)` #### Invalid Commit Messages: @@ -217,7 +217,7 @@ We follow a standardized commit message format using Commitlint to ensure consis - `Fixed a bug` - `Updated code` - `auth feature update` -- `chore: fixed some stuff` +- `chore: fixed some stuff ### Commit Example with Commitlint: From a78e004c6a6d12250cc18e9c62166e75db4bda4f Mon Sep 17 00:00:00 2001 From: Christine Belzie <105683440+CBID2@users.noreply.github.com> Date: Thu, 10 Aug 2023 08:37:37 -0400 Subject: [PATCH 2/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 10667f5da..9d0963db1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -91,7 +91,7 @@ Thank you for taking the time to contribute to our project. Please take a moment - `name`: Name of the site - - `Description`: A brief description of what the site does + - `description`: A brief description of what the site does - `URL`: Add a valid URL of the site - `Category`: Choose an existing category or create a new one following the instructions mentioned above. - `subcategory`: Choose an existing subcategory or create a new one following the instructions mentioned above. From 6a2b1e8e02cec13f605052c2f209db524e9e730b Mon Sep 17 00:00:00 2001 From: Christine Belzie <105683440+CBID2@users.noreply.github.com> Date: Thu, 10 Aug 2023 08:37:42 -0400 Subject: [PATCH 3/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d0963db1..36e77fb13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -92,8 +92,8 @@ Thank you for taking the time to contribute to our project. Please take a moment - `name`: Name of the site - `description`: A brief description of what the site does - - `URL`: Add a valid URL of the site - - `Category`: Choose an existing category or create a new one following the instructions mentioned above. + - `url`: Add a valid URL of the site + - `category`: Choose an existing category or create a new one following the instructions mentioned above. - `subcategory`: Choose an existing subcategory or create a new one following the instructions mentioned above. - `language`: This field is included for some of the resources, such as _React_ resources or _YouTube_ channel links. If multiple languages are involved, prioritize English if available. Otherwise, choose a language that you deem necessary. From 773325af1c1920936bf4cdc0b5ae10e2ae40cbd1 Mon Sep 17 00:00:00 2001 From: Abhisar Yadav <112550486+abhisar-yadav@users.noreply.github.com> Date: Thu, 10 Aug 2023 22:54:55 +0530 Subject: [PATCH 4/4] Update CONTRIBUTING.md Co-authored-by: Christine Belzie <105683440+CBID2@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 36e77fb13..0aa1ec1aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -100,7 +100,7 @@ Thank you for taking the time to contribute to our project. Please take a moment - You can use [JSONLint](https://jsonlint.com/) to check the correctness of the JSON to avoid failing tests during pull requests. **NOTE** -When adding _YouTube_ channel link, please specify _the language_ of the channel they are using to teach for example English, Hindi, Spanish, etc. In cases where the language is NOT specified, then just remove the `language` property. +When adding _YouTube_ channel links, please specify _the language_ of the channel they are using to teach for example English, Hindi, Spanish, etc. In cases where the language is not specified, then just remove the `language` property. > **⚠️Important** >