-
Notifications
You must be signed in to change notification settings - Fork 10
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
Conversation
There was a problem hiding this 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
?
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:
|
I would do so :). |
@@ -0,0 +1,55 @@ | |||
**Contributions are welcome.** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What sorts?
There was a problem hiding this comment.
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.
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). |
This project should have had one way earlier.