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 guidelines are somewhat easy to miss #2346

Closed
marcaddeo opened this issue Sep 6, 2024 · 1 comment
Closed

Contributing guidelines are somewhat easy to miss #2346

marcaddeo opened this issue Sep 6, 2024 · 1 comment

Comments

@marcaddeo
Copy link
Contributor

I opened two PR's recently (#2342, #2344) before finding out there's actually a contributing guide at the bottom of the README.

This happened because I searched the issues for related things about inlining aliases next to recipes in --list and saw there were earlier discussions about this. So I decided I'd give it a go, and got it done. Then when opening a PR/Issue for the first time, you're presented with this popup from GitHub:

image

The contributing guidelines link there goes to the repositories CONTRIBUTING.md which only briefly talks about licensing. So I didn't realize there were actual guidelines for contributing until today when I was just looking through issues and saw a reference to it.

Anyway, with not knowing the guidelines existed I opened #2344 which may have been better suited to start as an issue for discussion.

Maybe it would make sense to update the CONTRIBUTING.md file to have a link to the README section that includes the guidelines, or have them in CONTRIBUTING.md and have the README link to it.

@casey
Copy link
Owner

casey commented Sep 6, 2024

Good idea! I just merged #2348 which links to the readme from CONTRIBUTING.md.

@casey casey closed this as completed Sep 6, 2024
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

2 participants