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

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

Open
BekahHW opened this issue May 23, 2024 · 8 comments

Comments

@BekahHW
Copy link
Member

BekahHW commented May 23, 2024

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!

@adiati98
Copy link
Member

adiati98 commented May 30, 2024

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. 😊

@BekahHW
Copy link
Member Author

BekahHW commented May 30, 2024

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

@CBID2
Copy link
Contributor

CBID2 commented May 30, 2024

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

@amateurManu
Copy link

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

@AdityaSrivastava185
Copy link

AdityaSrivastava185 commented Aug 28, 2024

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

@BekahHW
Copy link
Member Author

BekahHW commented Aug 28, 2024

@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.

@MiirzaBaig
Copy link

has the issue closed or still on...?

@adiati98
Copy link
Member

adiati98 commented Sep 23, 2024

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants