docs: Update README

Question

docs: Update README

adiati98 opened this issue 9 months ago · comments

Ayu Adiati commented 9 months ago

Description

There are things that can be improved in the README as follows:

Fix wordings.
- OpenSauced has several websites. And currently, in the Getting Started section, we have a link to the Intro to OSS website with text "opensauced" (with no capital letters).
- In the Building Your Open Source Resume section, there's a suggestion to read the "Building Your Open Source Resume" section in chapter 6. However, there is no section with this title. Instead, there is a Develop your Open Source Resume section.
Update Course Overview section.

Currently, there are 5 chapters mentioned in this section. But we have 6 chapters now, including Types of contributions .
There is no link to our i18n guidelines in the 🤝 Contributing to this Repository section.

Suggestion

Fix wordings
- Change the link text of the website to "Intro to Open Source course" to clarify the target website.
```
... visit the [Intro to Open Source with OpenSauced](https://intro.opensauced.pizza/) website and start reading!
```
- There are two options to update the title in the "Building Your Open Source Resume" section:
  1. Change "Building Your Open Source Resume" to "Develop your Open Source Resume" to match the course.
  2. Change the title in the course from "Develop your Open Source Resume" to "Building Your Open Source Resume".
  After updating, link the section instead of linking the chapter 6.
Update Course Overview section.

Add the Types of contributions chapter.
Add a link to i18n Guidelines for translation.

Ayu Adiati · Answer 1 · Fri Nov 10 2023 20:18:20 GMT+0800 (China Standard Time)

@BekahHW @CBID2 I need your opinion on the point 2.
Then I'd like to .take this issue. Thank you! 😊

github-actions · Answer 2 · Fri Nov 10 2023 20:21:23 GMT+0800 (China Standard Time)

Thanks for being interested in this issue. It looks like this ticket is already assigned to a contributor.

Christine Belzie · Answer 3 · Sat Nov 11 2023 03:24:41 GMT+0800 (China Standard Time)

@BekahHW @CBID2 I need your opinion on the point 2. Then I'd like to .take this issue. Thank you! 😊

Hi @adiati98! :) I'd go with option 2. How about we merge PR #92 first to prevent merge conflicts?

github-actions · Answer 4 · Sat Nov 11 2023 03:24:52 GMT+0800 (China Standard Time)

Thanks for being interested in this issue. It looks like this ticket is already assigned to a contributor.

Ayu Adiati · Answer 5 · Sat Nov 11 2023 03:34:17 GMT+0800 (China Standard Time)

Thanks for the input, @CBID2 🙂

I don't think there would be merge conflicts here because this one is on chapter 6, and the PR you mentioned is on chapter 5.

Christine Belzie · Answer 6 · Sat Nov 11 2023 03:54:48 GMT+0800 (China Standard Time)

Thanks for the input, @CBID2 🙂

I don't think there would be merge conflicts here because this one is on chapter 6, and the PR you mentioned is on chapter 5.

Oh ok @adiati98

Ayu Adiati · Answer 7 · Sun Nov 12 2023 23:18:04 GMT+0800 (China Standard Time)

@BekahHW @CBID2
Heads up, I'm changing the title and descriptions in this issue as I found some things to be improved in the README.
TIA! 😊