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

Create Contributing guide information #1039

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lawik
Copy link
Contributor

@lawik lawik commented Jan 6, 2025

Capturing automated checks that people can expect as well as actually trying to capture conventions and practices that are expected.

Capturing automated checks that people can expect as well as actually trying to capture conventions and practices that are expected.
@lawik lawik requested review from fhunleth and jjcarstens January 6, 2025 10:26
@lawik
Copy link
Contributor Author

lawik commented Jan 6, 2025

@fhunleth I know you have more and you might have opinions on what I included. Just edit away. I wanted to get this started but I don't think I can finish it without input. And I suppose there are just a few items and a couple of minutes to bang this out. Then we can look at making Credo plugins or something :)

@fhunleth
Copy link
Member

fhunleth commented Jan 6, 2025

@lawik I think this is great, but your PR reminded me that we already have a contributing guide. I hadn't looked at it in a really long time and feel that it's not only out of date now, but also missing some new things that you added. Here's a link to the old guide. https://github.com/nerves-project/.github/blob/main/CONTRIBUTING.md. Let me know if you think it's best to refresh it or do something else.

@lawik
Copy link
Contributor Author

lawik commented Jan 6, 2025

This document could be changed to be a coding-standards one. That Contributing guide is kind of wide and isn't the best thing to link someone who is in the midst of contributing code. The other one may also need some review but seems good overall :)

It mentions a Nerves Radar, is that a thing and is it relevant for outside contributors to know?

@fhunleth
Copy link
Member

fhunleth commented Jan 6, 2025

It mentions a Nerves Radar, is that a thing and is it relevant for outside contributors to know?

Oh gosh. That needs to be deleted.

I was under the impression that the CONTRIBUTING.md guide would appear in the GitHub UI somewhere, but it doesn't seem to. Maybe we delete the whole thing and go with yours. I would like it to be discoverable on all Nerves-related projects. Perhaps we should move the discussion to Discord since you uncovered something that's going to hit every repository.

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

Successfully merging this pull request may close these issues.

2 participants