Docs: Update the Contributing Guidelines
Closed this issue · 9 comments
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 Let's go with Alternative 1 and reduce the need to update in multiple places. We can link in the readme and make sure to mention that this is part of a course, so we recommend that you complete the course.
@adiati98 Let's go with Alternative 1 and reduce the need to update in multiple places. We can link in the readme and make sure to mention that this is part of a course, so we recommend that you complete the course.
Just to confirm here, @BekahHW. Alternative 1 is basically proposing to copy-paste the Let's Get Practical content to replace the content in the CONTRIBUTING file. So, whenever there is any change to the course, this file also needs to be updated.
@adiati98, whoops. I was thinking just linking to the Getting Practical section and not copy pasting.
I do think we still want to talk about issues and communication style here. But I don't feel super strongly about whether or not to have the contributing guide. I might lean towards keeping it, only bc I think it makes for a good example of what to expect in an open source project.
@BekahHW ah, I get what you mean. So, can we do it this way?
-
Remove the first paragraph because we will mention it in a new section (this is outdated anyway because we don't use chapter number anymore) and change it to something like:
This repository is part of our [Intro to Open Source course](https://opensauced.pizza/learn/intro-to-oss/). We recommend you to take and complete the course before you contribute to this repository.
-
Keep the Communication Style and Issues sections.
-
Remove the rest of the sections.
-
Add a section called "Getting Started" and use modified wording from the first paragraph, something like:
Please follow the [Let's Get Practical](https://opensauced.pizza/learn/intro-to-oss/how-to-contribute-to-open-source#lets-get-practical) section of the [Intro to Open Source course](https://opensauced.pizza/learn/intro-to-oss/).
If this is a go, I'll work on it so we can have this and the translation removal up before Hacktoberfest.
Hey @BekahHW,
I just realized that the all information in the "Issues" section in the contributing guidelines is pointing to the "intro" repo, and not "guestbook".
Also, at guestbook, we don't apply the .take action. We might want to remove this section. Or do you have any other thoughts?