Skip to content

Formatting changes to CONTRIBUTING.md #468

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 7 commits into from
Oct 11, 2022
Merged

Formatting changes to CONTRIBUTING.md #468

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fab825c
Added a few changes. Which includes insertion of colons, correction o…
Mercysticks Oct 11, 2022
4e661b1
Fix linter issue
spier Oct 11, 2022
a091eec
Spelling fix
spier Oct 11, 2022
eea6425
Changing back to original formatting
spier Oct 11, 2022
53a2b6c
Changing back to original formatting
spier Oct 11, 2022
410fa3e
Changing back to original formatting
spier Oct 11, 2022
a10058c
Changing back to original formatting
spier Oct 11, 2022
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
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@

The goal of the InnerSource patterns working group is to collect, document, and publish InnerSource best practices. To make the best practices easy to comprehend, evaluate, and apply, we codify them in a specific structure - [the patterns format](meta/pattern-template.md). More infos on the working group can be found in our [README.md](README.md) file.

For this working group to strive, we welcome your contribution - be it small or huge.
For this working group to thrive, we welcome your contribution - be it small or huge.

## How to Contribute?

Please consider contributing to the InnerSource Patterns.
Here some ideas for ways to contribute:
Here some suggestions on how you can contribute.

1. **Share your thoughts & spark discussion**. A fresh perspective, an interesting thought, or an early novel idea can spark discussions and yield unforeseeable results. We invite you to share your thoughts on InnerSource-related topics at any time by [creating an issue](https://github.com/InnerSourceCommons/InnerSourcePatterns/issues/new), [via Slack, or our patterns office hours](#how-to-get-in-touch).
1. **Share your thoughts & spark discussion**: A fresh perspective, an interesting thought, or an early novel idea can spark discussions and yield unforeseeable results. We invite you to share your thoughts on InnerSource-related topics at any time by [creating an issue](https://github.com/InnerSourceCommons/InnerSourcePatterns/issues/new), [via Slack, or our patterns office hours](#how-to-get-in-touch).

2. **Read & improve existing patterns.** If you want to get started, we encourage you to read through the existing patterns and materials in this repository. Found a misleading phrase or phony grammar? A mistake in the content? Let us know by [creating an issue](https://github.com/InnerSourceCommons/InnerSourcePatterns/issues/new) or directly propose your fix as a pull request.
2. **Read & improve existing patterns**: If you want to get started, we encourage you to read through the existing patterns and materials in this repository. Found a misleading phrase or phony grammar? A mistake in the content? Let us know by [creating an issue](https://github.com/InnerSourceCommons/InnerSourcePatterns/issues/new) or directly propose your fix as a pull request.

3. **Confirm that you are using a pattern** When multiple orgs confirm that they are using a pattern, that increases the relevance of the pattern as it lets other adopters known that this pattern is proven. If you are using one of our patterns, you can list your org as **Known Instance** on the given pattern, together with a description of the experiences that you made applying it. Here some examples of [great Known Instances descriptions](patterns/2-structured/document-your-guiding-principles.md#known-instances).
3. **Confirm that you are using a pattern**: When multiple organisations confirm that they are using a pattern, that increases the relevance of the pattern as it lets other adopters known that this pattern is proven. If you are using one of our patterns, you can list your org as **Known Instance** on the given pattern, together with a description of the experiences that you made applying it. Here some examples of [great Known Instances descriptions](patterns/2-structured/document-your-guiding-principles.md#known-instances).

4. **Translate existing patterns.** When implementing InnerSource practices in your region, there can be language barriers for people as most of the InnerSource content is available in English. Therefore we see great value in getting people in your region/organization to understand InnerSource in their own language. To help us translate patterns to other languages please refer to [these translation instructions](translation/README.md).
4. **Translate existing patterns**: When implementing InnerSource practices in your region, there can be language barriers for people as most of the InnerSource content is available in English. Therefore we see great value in getting people in your region/organization to understand InnerSource in their own language. To help us translate patterns to other languages please refer to [these translation instructions](translation/README.md).

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.
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 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).

7. **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!
7. **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?

Expand Down