Skip to content

Update contributing guide #247

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

Open
cassidoo opened this issue Apr 17, 2025 · 10 comments
Open

Update contributing guide #247

cassidoo opened this issue Apr 17, 2025 · 10 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@cassidoo
Copy link
Contributor

cassidoo commented Apr 17, 2025

Right now CONTRIBUTING.md could use some more guidance at the top.

Add more of a walkthrough for users, for example:

  • "If you want to add a new event, go here"
  • "If you want to add a new resource, do it like this"
  • etc.

Also, add contribution guidelines for folks wanting to do minor fixes like typos, or more structural code changes.

@cassidoo cassidoo added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 17, 2025
@iambel
Copy link

iambel commented Apr 17, 2025

hi!
i'd like to work on this issue, if it's still available. thanks (●'◡'●)

@cassidoo
Copy link
Contributor Author

@iambel go for it!

@adiati98
Copy link
Contributor

adiati98 commented Apr 17, 2025

Love this initiative! ❤

We might as well want to consider having:

  • if folks should or no need to create issue before working on a fix
  • if folks can go ahead working on an issue and creating a PR without asking permission or if they need to ask permission first and get assigned

Which one to apply is maintainers' call. 👍🏼

Also:

  • As there is no issue form & PR template yet in this repo, what info would you want to have in the issue & PR from contributors? For example:

    • Issue: Clear description, how to reproduce a bug (if it's bug reporting), screenshot/screen recording if it's UI related, etc.
    • PR: Clear description, link to the issue (if any), etc.

Edit: What I mean by issue form here is the form to submit a bug report and feature request.


Adding clarity might be helpful for new (even experienced!) folks in OSS. And it'll make the maintainers' tasks lighter as well.😊

I'll chime in more ideas when I can think more! ✨

@LukysYeep
Copy link

Hi!

I am looking forward to fix this issue if it is still open, thanks!

@adiati98
Copy link
Contributor

Hey @LukysYeep ,
This issue is already assigned. You can see at the "assignees" section on the right. 🙂

@LukysYeep
Copy link

Oh my bad, I did not notice @adiati98 ,
is it fine, if I collaborate on this issue? 😊

@adiati98
Copy link
Contributor

Hey @LukysYeep,
Coming from this comment, I'm currently also sort of collaborating by chiming in ideas here.

If you have some thoughts, you can comment here.
The maintainers of the repo might have ideas or responses to your thoughts. 🙂

@karasowles
Copy link
Collaborator

Thanks all!

@iambel @LukysYeep you're always welcome to work on things, no need to ask! Thanks for volunteering to help. Sorry for swooping in and making an update :)

I've asked Copilot Agent mode to incorporate the suggestions from here (thanks @adiati98 !) and make updates to the file: #295

@iambel
Copy link

iambel commented Apr 23, 2025

Oh, so it's already finished?

@karasowles
Copy link
Collaborator

Not necessarily - does the contributing guide look clear enough now? It might still need improvements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants