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

Add contributing guide #139

Merged
merged 6 commits into from
Dec 9, 2024
Merged

Add contributing guide #139

merged 6 commits into from
Dec 9, 2024

Conversation

chrysn
Copy link
Member

@chrysn chrysn commented Nov 30, 2024

This project should have had one way earlier.

  • @kbarning and @Teufelchen1, would this document have made work on the UART wrappers easier?
  • @jkarinkl, you've had your hands on a few texts on what contributing guides should look like – could this work?

Copy link
Contributor

@Teufelchen1 Teufelchen1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's on point! Do you think we should add a link to this document in the README.md?

@jkarinkl
Copy link

jkarinkl commented Dec 9, 2024

Nice @chrysn! Looks good.

In general a Contributing Guide has the goal to "increase the number of successful contributors to your project" (CNCF HowTo: Make a Contributing Guide).

Therefore it is handy to ask: what is the intended audience for this document? What is the background/level of knowledge/experience of these contributors, and thus what content should be added in the CG? (from @Teufelchen1's approval, I expect the content fits the audience here).

Some general things to check if they are relevant to add:

  • Where and how can people ask for help and/or interact?
    • If this is different from the general channels people can use when contributing to RIOT
    • Also: is this question relevant, or do the people who want to contribute to this project already know regular ways to contact you/the maintainers of this project? Then it does not need to be mentioned in the CG.
  • What kind of contributions are welcome?
    • Code only?
    • Documentation? (if relevant)
    • ...?
  • When should PRs be submitted?
    • As work-in-progress
    • Or when finished?

@jkarinkl
Copy link

jkarinkl commented Dec 9, 2024

It's on point! Do you think we should add a link to this document in the README.md?

I would do so :).

CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@@ -0,0 +1,55 @@
**Contributions are welcome.**
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What sorts?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather not limit peoples' imagination. People will have an idea what they want to do by the time they get to this document, and if someone wants to contribute an introduction poem, I'm happy to review metre.

@chrysn
Copy link
Member Author

chrysn commented Dec 9, 2024

Thanks for your input, I've pushed commits to address those which I marked as resolved without a further comment. This includes a link to the matrix channel. (GitHub is an implied channel – but people read this so they already found that).

The audience this is intended for is people who already do consider contributing to the repository. For code contributions, which so far are the overwhelming majority (actually your response is probably the first non-code one 🥇), there's some implied level of experience; I wouldn't know how to put that in text without discouraging small fixes by newcomers. I'd trust the "common pitfalls" section (as well as recently introduced "Callback lifetimes are hard" in the tl;dr) to discourage completely inexperienced people from attempting to do large things (and when that does not work, chances are that a level of hubris is involved for which "some experience is expected" won't do any good either).

@chrysn chrysn enabled auto-merge December 9, 2024 15:22
@chrysn chrysn merged commit 79c38fc into main Dec 9, 2024
81 checks passed
@chrysn chrysn deleted the contributing branch December 9, 2024 16:03
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.

3 participants