Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md #1554

Merged
merged 4 commits into from
Aug 10, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand Down Expand Up @@ -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**
>
Expand Down Expand Up @@ -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:
Expand All @@ -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:

Expand Down
Loading