-
Notifications
You must be signed in to change notification settings - Fork 202
Improve contribution pathway #862
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
base: main
Are you sure you want to change the base?
Improve contribution pathway #862
Conversation
…/InnerSourcePatterns into improve-contribution-pathway
CONTRIBUTING.md
Outdated
| 5. **Review open pull requests**: Even without knowing all the specifics of the patterns working group, your feedback on existing [pull requests](https://github.com/InnerSourceCommons/InnerSourcePatterns/labels/type%20-%20Content%20work) (especially those proposing changes to pattern contents) will be valuable to its authors: As somebody who wants to learn more about InnerSource, you can give input from the perspective of a future reader. As somebody with own InnerSource experiences, you can share your experience with the authors. | ||
|
|
||
| 6. **Contribute a new pattern**: A key contribution you can make is to document an InnerSource best practice you experienced or know about. We defined different maturity levels for the contents in this repository: First time contributors should aim for maturity levels `1: initial` (for unstructured experience reports or what we call donuts - patterns with missing pieces) and `2: structured` (for best practices adhering to the patterns format and following basic writing style conventions). Our [Contributor Handbook](meta/contributor-handbook.md) discusses all this in more detail. You don't feel ready yet to contribute a new pattern? Please start a discussion by [creating an issue](https://github.com/InnerSourceCommons/InnerSourcePatterns/issues/new). | ||
| 6. **Contribute a new pattern**: A key contribution you can make is to document an InnerSource best practice you experienced or know about. We defined different maturity levels for the contents in this repository: First-time contributors should aim for maturity levels `1: initial` (for unstructured experience reports or what we call donuts—patterns with m basic writing style conventions). Our [Contributor Handbook](meta/contributor-handbook.md) discusses all this in more detail. You can also use the [Drafting InnerSource Pattern with AI](/meta/pattern-drafts-with-ai.md) instructions to quickly produce content for a new pattern. You don't feel ready to contribute a new pattern yet? Please start a discussion by [creating an issue](https://github.com/InnerSourceCommons/InnerSourcePatterns/issues/new). |
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.
@jeffabailey I am not sure what you mean by "with m basic writing style conventions".
I guess the "m" in there is a typo for sure. ;)
The real definition of a Donut pattern is pattern with out a Solution (i.e. a hole in the middle).
However maybe we should leave that whole internal language away as nobody understands it anyways?
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.
Yes, typo for sure. :)
I removed the donut pattern description. I agree, it's confusing.
We may benefit from some pattern structure linting at some point to help prevent donut patterns.
chore: remove donut description
No description provided.