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

merged 4 commits into from
Dec 17, 2023

Conversation

CBID2
Copy link
Collaborator

@CBID2 CBID2 commented Dec 17, 2023 •
edited
Loading

Fixes Issue

Closes #2205

Changes proposed

This PR addresses the following issues:

  1. Adds Aftan to the Maintainer's section in the README file
  2. Adds a code snippet in the section of Contributing guide that describes the steps to adding categories/subcategories.

Screenshots

Change to README file

code snippet in contributing guide

Change to Contributing Guide

aftan's image in the maintainer's section

Note to reviewers

@CBID2 CBID2 added documentation Improvements or additions to documentation priority: low Addition of new links/categories or doing any small task (e.g fixing typos) labels Dec 17, 2023
@CBID2 CBID2 self-assigned this Dec 17, 2023
@vercel Vercel
Copy link

vercel bot commented Dec 17, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
linkshub ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 17, 2023 2:01am

github-actions[bot]
github-actions bot reviewed Dec 17, 2023
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, CBID2, for creating this pull request and contributing to LinksHub! 💗

The maintainers will review this Pull Request and provide feedback as soon as possible! 😇
We appreciate your patience and contribution, Keep up the great work! 😀

@CBID2
Copy link
Collaborator Author

CBID2 commented Dec 17, 2023

@Anmol-Baranwal, @aftabrehan, and @rupali-codes, please review my PR.

aftabrehan
aftabrehan requested changes Dec 17, 2023
View reviewed changes
Copy link
Collaborator

@aftabrehan aftabrehan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent PR, @CBID2 💪 🚀 💯

Could you please check these suggestions?

README.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CBID2 and others added 2 commits December 16, 2023 21:00
@CBID2 @aftabrehan
fix: revise Aftan's last name
de64b54 
Co-authored-by: Aftab Rehan <workwithaftabrehan@gmail.com>
@CBID2 @aftabrehan
fix: revise format for note
4a738e8 
Co-authored-by: Aftab Rehan <workwithaftabrehan@gmail.com>
@CBID2
Copy link
Collaborator Author

CBID2 commented Dec 17, 2023

Excellent PR, @CBID2 💪 🚀 💯

Could you please check these suggestions?

Done @aftabrehan

Anmol-Baranwal
Anmol-Baranwal reviewed Dec 17, 2023
View reviewed changes
Copy link
Collaborator

@Anmol-Baranwal Anmol-Baranwal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You removed the context where they can check category descriptions. Will anyone who is new to the codebase not face a problem finding where they can check the code, since it is in another component TopBar?

It's up to you. Let me know, and I will approve the PR.

image

@CBID2
Copy link
Collaborator Author

CBID2 commented Dec 17, 2023

You removed the context where they can check category descriptions. Will anyone who is new to the codebase not face a problem finding where they can check the code, since it is in another component TopBar?

It's up to you. Let me know, and I will approve the PR.

image

Good point @Anmol-Baranwal! :) I'll add that back in there.

rupali-codes
rupali-codes approved these changes Dec 17, 2023
View reviewed changes
Copy link
Owner

@rupali-codes rupali-codes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm

@rupali-codes rupali-codes merged commit ffa4d1c into rupali-codes:main Dec 17, 2023
7 checks passed
@CBID2
Copy link
Collaborator Author

CBID2 commented Dec 17, 2023 •
edited
Loading

You removed the context where they can check category descriptions. Will anyone who is new to the codebase not face a problem finding where they can check the code, since it is in another component TopBar?

It's up to you. Let me know, and I will approve the PR.

image

@Anmol-Baranwal, my PR got merged before I could make the change. Can you add it in a new PR? :)

@CBID2 CBID2 requested review from Anmol-Baranwal and removed request for Anmol-Baranwal December 17, 2023 15:26
@Anmol-Baranwal
Copy link
Collaborator

@Anmol-Baranwal, my PR got merged before I could make the change. Can you add it in a new PR? :)

No worries! If anyone faces that problem, we can let them know.

No need of a new PR.

@CBID2
Copy link
Collaborator Author

CBID2 commented Dec 17, 2023

@Anmol-Baranwal, my PR got merged before I could make the change. Can you add it in a new PR? :)

No worries! If anyone faces that problem, we can let them know.

No need of a new PR.

Ok good @Anmol-Baranwal! 😁

CBID2 added a commit to CBID2/My-version that referenced this pull request Dec 23, 2023
@CBID2
Revert "docs: updating the README and Contributing Guide (rupali-code…
bb87663 
…s#2207)"

This reverts commit ffa4d1c.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Anmol-Baranwal Anmol-Baranwal Anmol-Baranwal left review comments

@github-actions github-actions[bot] github-actions[bot] left review comments

@aftabrehan aftabrehan aftabrehan approved these changes

@rupali-codes rupali-codes rupali-codes approved these changes

Assignees

@CBID2 CBID2

Labels
documentation Improvements or additions to documentation priority: low Addition of new links/categories or doing any small task (e.g fixing typos)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: Updates needed
4 participants
@CBID2 @Anmol-Baranwal @rupali-codes @aftabrehan