Skip to content

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.

Sign up for GitHub

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

Merged
merged 8 commits into from
Nov 7, 2025
Merged

Improve contribution pathway #862

Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2bfa32e
feat: add reciprocal links to AI draft and contrib
jeffabailey Nov 4, 2025
5b007c1
Change numbering
spier Nov 4, 2025
c557b3d
Change numbering
spier Nov 4, 2025
9467576
chore: merge new pattern bullets
jeffabailey Nov 5, 2025
0d4ea3a
Merge branch 'improve-contribution-pathway' of github.com:jeffabailey…
jeffabailey Nov 5, 2025
433c482
Merge branch 'InnerSourceCommons:main' into improve-contribution-pathway
jeffabailey Nov 6, 2025
492981a
chore: remove blank line
jeffabailey Nov 6, 2025
0558c47
chore: remove typo
jeffabailey Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,12 @@ Please consider contributing to the InnerSource Patterns.

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).
Copy link
Member

@spier spier Nov 6, 2025

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?

Copy link
Contributor Author

@jeffabailey jeffabailey Nov 7, 2025

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.

Copy link
Member

@spier spier Nov 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@jeffabailey we have a linter for the pattern structure already. However we only apply it to maturity level Structured. i.e. for Draft patterns the authors can do whatever they want really (on purpose).


7. **Draft a Pattern with AI:** Use the [Drafting InnerSource Pattern with AI](/meta/pattern-drafts-with-ai.md) instructions to quickly produce content for a new pattern.

8. **Be a patterns advocate**: The patterns will become better and cover more topics the more people contribute their perspective and experience. A colleague told you about a novel InnerSource best practice? Please invite her/him to contribute to this repository!


## How to get in touch?

We are happy to support you in contributing to the InnerSource patterns or to just chat with you.
Expand Down