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

Docs: Update the Contributing Guidelines #362

Open
adiati98 opened this issue Jun 10, 2024 · 1 comment
Open

Docs: Update the Contributing Guidelines #362

adiati98 opened this issue Jun 10, 2024 · 1 comment
Labels
docs team documentation Improvements or additions to documentation 👀 needs-triage

Comments

@adiati98
Copy link
Member

adiati98 commented Jun 10, 2024

Description

As part of Intro to OSS course, the contributing guidelines in this guestbook repo is following and being adjusted from the guidelines at the intro repository. But as the intro repository evolves, the contributing guidelines in this repo is no longer 100% accurate. Therefore, it needs to be updated.

Another reason is as Hacktoberfest is approaching, we want to make this repo ready for contributions not only from the course participants, but also from folks who don't take our Intro to OSS course.

Suggested Solution

Alternative 1

Update the contributing guidelines by adding instructions from Let's Get Practical section and adjust other sections accordingly.

Alternative 2

Remove the contributing guidelines completely with below reasons:

  • We have the Getting Started section on the README that navigate folks to the instructions of adding themselves to the guestbook.
  • The Contributing section on the README already holds the information for folks to improve our Intro to OSS course.
@adiati98 adiati98 added documentation Improvements or additions to documentation 👀 needs-triage docs team labels Jun 10, 2024
@adiati98
Copy link
Member Author

@BekahHW I need your thoughts on this. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs team documentation Improvements or additions to documentation 👀 needs-triage
Projects
None yet
Development

No branches or pull requests

1 participant