feat: Add a guide for writing good commit messages and PR descriptions to the Intro to OSS course

Question

feat: Add a guide for writing good commit messages and PR descriptions to the Intro to OSS course

Opened this issue 6 months ago · 8 comments

In a comment on oss.fyi/ph, someone asked about a guide for new contributors. I think this will be a great addition to our course!

Answer 1 · 2024-05-30T11:05:26.000Z

This sounds great!

We kind of have a brief guide for writing PR descriptions in this section. I'll see if we can improve it, and let me know if you have any idea, @BekahHW!

But we definitely still need to add the guide to write commit message. 😊

Answer 2 · 2024-05-30T16:51:43.000Z

I saw that before I posted. I'm thinking more in depth and covering a variety of types. More like this.

Answer 3 · 2024-05-30T18:20:13.000Z

I saw that before I posted. I'm thinking more in depth and covering a variety of types. More like this.

This guide looks good @BekahHW. I think the key thing to mention is

Why effective commits are important
How they make it easier for maintainers to review your contribution
I did something similar here

Answer 4 · 2024-07-06T09:59:24.000Z

Hello, has the issue been assigned to a contributor so far?

Answer 5 · 2024-08-28T18:44:09.000Z

Hello @adiati98 I want to work on this issue , please assign it to me

Answer 6 · 2024-08-28T20:46:42.000Z

@adiati98 I've been thinking a bit about this, do you think it makes sense to add a "Guides" section? Whether that's part of the contrib course or as a separate entity. For example, we'd have the contrib course, maintainer course, and additional guides.

Answer 7 · 2024-09-22T11:47:44.000Z

has the issue closed or still on...?

Answer 8 · 2024-09-23T09:58:12.000Z

@adiati98 I've been thinking a bit about this, do you think it makes sense to add a "Guides" section? Whether that's part of the contrib course or as a separate entity. For example, we'd have the contrib course, maintainer course, and additional guides.

@BekahHW, sorry I missed this one!

I think, having more detailed guides is a great idea! I'm leaning towards making it a separate entity. My thoughts behind this are:

We have subsections in each course that briefly explain how to do things. For example, "Fill In a Pull Request Template" section in the contrib course, "Creating Issue Forms" section in the maintainer course, etc. So, having the section as part of the course is not necessary.
Having a "Guides" section in each course could be confusing, as our course is basically guiding folks to contribute to or maintain a project.
We already have an "Additional Resources" for each course. Having a "Guides" section feels like repeating although the contents would be different.
Having the section as a separate entity would allow us to expand the guides without worrying about the structure and how to make it flow within the course. I'm thinking the structure would be something like this:
```
Open Source Education Path/
├── Intro to Open Source Course
├── Becoming a Maintainer Course
└── Practical Guides (or Tutorials (?))/
    ├── Contributors
    └── Maintainers
```