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.

Sign up for GitHub

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

Jump to bottom

docs: updating the README and Contributing Guide #2207

Merged
merged 4 commits into from
Dec 17, 2023
Merged

docs: updating the README and Contributing Guide #2207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
416fe76
docs: updating the README and Contributing Guide
CBID2 Dec 17, 2023
5b69b37
fix: Bolded heading
CBID2 Dec 17, 2023
de64b54
fix: revise Aftan's last name
CBID2 Dec 17, 2023
4a738e8
fix: revise format for note
CBID2 Dec 17, 2023
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
17 changes: 13 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ⚠️
Expand Down Expand Up @@ -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.

---

Expand Down
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Loading