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

Contributing guide and pull request template? #53

Open
ninjamuffin99 opened this issue Jan 26, 2023 · 3 comments
Open

Contributing guide and pull request template? #53

ninjamuffin99 opened this issue Jan 26, 2023 · 3 comments

Comments

@ninjamuffin99
Copy link
Member

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

@doggogit
Copy link
Contributor

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

@MarkimusZer0
Copy link
Contributor

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

@EliteMasterEric
Copy link
Member

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

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

No branches or pull requests

4 participants