awesome-funkin-resources icon indicating copy to clipboard operation
awesome-funkin-resources copied to clipboard

Contributing guide and pull request template?

Open ninjamuffin99 opened this issue 2 years ago • 3 comments

I think having and linking to a nice little contributing guide can be nice and tasty.

https://github.com/sindresorhus/awesome/blob/main/contributing.md#adding-something-to-an-awesome-list

One part in particular that I think would be good is something similar to this guide that runs people through the BASIC basics of editing a github readme. Not everyone knows how github works intuitively! So having as much accessibility like that is nice.

As well as that, other GUIDELINES like what is a GOOD addition / pull request to the list.

I'd say pull requests right now are decent so I feel like we can take a bit of time and draft up something nice heheh.

https://github.com/sindresorhus/awesome/blob/main/pull_request_template.md

This pull request template is also tasty heheh

ninjamuffin99 avatar Jan 26 '23 00:01 ninjamuffin99

Might whip up a draft myself, but that might be tomorrow, as I'm feelin' pretty tired as of right now

If anyone does a draft before me, I can look at it tomorrow and leave suggestions and such

doggogit avatar Jan 26 '23 00:01 doggogit

I think more or less you should just instruct people on the formatting used like "Use (#section-name) to refer to a section when creating a new one in a pull request". At least cause I'm not sure how you'd make a template for dis kinda stuff

MarkimusZer0 avatar Jan 26 '23 20:01 MarkimusZer0

I think the main thing to add is that people can go to the README.md and click the pencil button to edit it in browser without any additional steps

EliteMasterEric avatar Jan 27 '23 04:01 EliteMasterEric