johko / computer-vision-course

This repo is the homebase of a community driven course on Computer Vision with Neural Networks. Feel free to join us on the Hugging Face discord: hf.co/join/discord
MIT License
376 stars 124 forks source link

Adding a proposal to bring some changes in the contributing guidelines. #71

Closed Anindyadeep closed 7 months ago

Anindyadeep commented 7 months ago

This proposal is made due to the following reasons:

  1. There are lots of amazing folks who are interested in contributing to this but can not due to pre-allocation of contributors in this sheet.
  2. However, there are several times, where the contributor who got initially assigned to do the task got ideal for some time.
  3. Also, most of the team-members are in different timezones, so hard to sync up everytime.
  4. Trying to make things easier for reviewers and maintainers to iterate on things faster.

This proposal includes:

  1. A new contributing guideline structure and instructions on how to get started in contributing.
  2. Also some additional proposals for reviewers/course-maintainers side and some rules on how the issue and PR should look like.

This is an open conversation, I would like to take feedbacks and make changes accordingly. Let's make this public course go brrr 🤗

Anindyadeep commented 7 months ago

Hi, @Anindyadeep. Like you, I'm interested in making this process more decentralized, but let me share with you my thoughts after I've read your proposal and correct me if I didn't get you right.

So, we are going to need to rewrite (or at least refine) the proposed outlines as most of them are drafts and not definitive yet, to make them new-comer-friendly, am I right? If so, I think this is going to take more time for each group to think more carefully about the outline and its granular details rather than starting to write content and submit pull requests and iterate, and the sprint is supposed to start tomorrow.

I like this approach, but I think this sprint is a good way push the work forward. Thank you, those were just my two cents.

Hey @mmhamdy, thanks for the feedback, since from tomorrow, the sprints start. So, one thing we can do is prioritize our content more than the structure. As @merveenoyan mentioned, we can simply solve merge conflicts and first gets some PR merged, then may be on seperate PRs, can propose their structuring. But the priosity should be the following imo:

  1. Get the contents and PR merged.
  2. Working async and decentralized.
kfahn22 commented 7 months ago

My suggestion in to add the structure to the existing Google Docs so that the progress can be monitored and new contributors can figure out where they can plug in , using Synthetic Data Creation as an example.

pull
seshupavan commented 7 months ago

Everyone is coming up with interesting ideas about updated contributing guidelines along with new ideas, to make it possible, organized and less messy. I request the maintainers to open Discussions section for this repo so they all go in one place.

Anindyadeep commented 7 months ago

Everyone is coming up with interesting ideas about updated contributing guidelines along with new ideas, to make it possible, organized and less messy. I request the maintainers to open Discussions section for this repo so they all go in one place.

Yes, makes sense. I mean we really need to come up with a conclusion here.

johko commented 7 months ago

I enabled the discussion feature @seshu-pavan, feel free to comment in there.

And sorry, @Anindyadeep I wanted to review the approach right now, but my brain is too tired right now :sleeping: But in general I can say I appreciate the effort of adding granularity, now that we have a lot of outlines and are more certain on the topics we are working on.

The How probably is the biggest question right now.

More of my thoughts tomorrow (in Central European Timezone)

merveenoyan commented 7 months ago

@johko in the PR @Anindyadeep is providing the how very well, it would be nice to make a decision and if we're in favour get it merged soon so people can adapt them 😊

johko commented 7 months ago

Okay, I went through the proposal just now and I think overall it is good, but might still be a bit confusing to find the right place for new contributors especially. Clicking through all the issues can be a bit of a hustle, because issues just are hard to sort for beginners.

So my proposal: Let's use the Discussion feature instead. We can have the section Chapters and for each team there is an own category. We can have a pinned issue for the Outline and then have one issue each for a sub-part of this section. I created a mock for the Video and Video Processing section here: https://github.com/johko/computer-vision-course/discussions/categories/video-video-processing

I think it just has a nicer UI than the issues tab, but still essentially follows the proposed workflow.

What do you think @merveenoyan @Anindyadeep ?

kfahn22 commented 7 months ago

@johko I like this above approach but suggest but it would be nice to add in checklist re status and potentially where new contributors can plug in.

Anindyadeep commented 7 months ago

Okay, I went through the proposal just now and I think overall it is good, but might still be a bit confusing to find the right place for new contributors especially. Clicking through all the issues can be a bit of a hustle, because issues just are hard to sort for beginners.

So my proposal: Let's use the Discussion feature instead. We can have the section Chapters and for each team there is an own category. We can have a pinned issue for the Outline and then have one issue each for a sub-part of this section. I created a mock for the Video and Video Processing section here: https://github.com/johko/computer-vision-course/discussions/categories/video-video-processing

I think it just has a nicer UI than the issues tab, but still essentially follows the proposed workflow.

What do you think @merveenoyan @Anindyadeep ?

This looks pretty good, so should I update the instruction according referencing the discussion section or should we close this PR?

johko commented 7 months ago

This looks pretty good, so should I update the instruction according referencing the discussion section or should we close this PR?

I think you can just modify this PR @Anindyadeep , as it already contains a lot of what would be in the new one anyway.

johko commented 7 months ago

We can also use the label "help wanted" to indicate sections where people are needed. So new members can then just filter the discussion with that label.

Anindyadeep commented 7 months ago

This looks pretty good, so should I update the instruction according referencing the discussion section or should we close this PR?

I think you can just modify this PR @Anindyadeep , as it already contains a lot of what would be in the new one anyway.

sure, can do that.

johko commented 7 months ago

Thanks @Anindyadeep , just waiting for @merveenoyan or @lunarflu for a napproval now, the new can merge. But I will already make an announcement about the workflow with the discussion part in the discord