Mention how Siemens applies some patterns

[fgreinacher]

This adds some instances to patterns we are applying at @siemens.

/cc @deveaud-m @bufferoverflow @nejch

[welcome]

💖 Thanks for opening this pull request! 💖 The InnerSource Commons community really appreciates your time and effort to contribute to the project. Please make sure you have read our Contributing Guidelines.

If you are submitting a new pattern, the following things will help get your pull request across the finish line! 🏁

• Confirm that you have used our pattern template. Please remove any placeholder text and sections that your pattern did not need.
• We run a number of automated checks on your PR. Please review the output of those checks on the PR itself, and see if any issues got flagged that you can fix yourself.
• Make sure you have added your new pattern to the list of patterns in the main README.md. If you are unsure where to add your pattern, just let us know by commenting on your PR and we will help you.

This project has a small number of maintainers, volunteering their time to this project. So please be patient and we will get back to you as soon as we can. If we don't acknowledge this pull request after 7 days, feel free to chat to us about it in our Slack workspace.

[fgreinacher]

@spier As promised, here you go :)

[spier]

Very cool, thank you for this. I especially like the short explanations!

I left some inline comments for you.

FYI I recently filed #799 after re-watching the recording of your FOSS Backstage talk. I think you PR here covers the quick wins already. Let's aim to get this one merged quickly, and then move any potential further topics to future issues/PRs.

[spier]

Are you comfortable sharing which tooling you are using for this? e.g. is it Backstage, a custom built site, something else?

[bufferoverflow]

For the documentation portal we are using MkDocs in combination with our internal docs-theme we maintain (reused > 2400 times, also Inner Source). But we also have a dedicated app using Django and another popular innersource framework for the UI, there we have detailed re-use metrics and do also calculate the re-use, usage, quality metric and much more.

[spier]

Thanks for the additional info @bufferoverflow. The measurement of re-use could even be a pattern in its own right but lets keep that for another day :) (I made a note of that)

How do you list the InnerSource projects? Do you just use the features of your gitlab instance to do that, or is there a dedicated places that shows InnerSource projects only?

[fgreinacher]

We're listing inner source projects on a dedicated page, also including additional data mentioned by @bufferoverflow above.

[bufferoverflow]

The measurement of re-use could even be a pattern in its own right but lets keep that for another day :) (I made a note of that)

@spier Yes, I think that would be worth to do. It's especially useful for reporting and if people see the numbers of re-use they could imagine the savings we had due to re-use Inner Source. This really helps to convince people.

[spier]

Btw through your PR I also noticed that we have some formatting inconsistencies in our patterns.

I did not want to distract your PR with fixing these. Will do so separately, once this PR is merged.

[fgreinacher]

Btw through your PR I also noticed that we have some formatting inconsistencies in our patterns.

I did not want to distract your PR with fixing these. Will do so separately, once this PR is merged.

Yep, I also noticed that. I adapted to the style in each file. Maybe some linting would be helpful 😀

[spier]

Btw through your PR I also noticed that we have some formatting inconsistencies in our patterns.
I did not want to distract your PR with fixing these. Will do so separately, once this PR is merged.

Yep, I also noticed that. I adapted to the style in each file. Maybe some linting would be helpful 😀

Good idea with the linter. We have a linter (based on markdownlint) but so far that only checks for the existence of the correct section titles from our pattern template. If you are curious, see pattern-template.js.

I guess one could also check other formatting conventions there, just I have never done that before with markdown.

If you got any, I am happy for any tips related to linting documents / markdown files.

[spier]

This looks amazing now. Let's bring this live, and then continue the conversation about potential other patters etc.

FYI I am leaving one comment open where a little conversation with @bufferoverflow is still ongoing.

[welcome]

Congrats on merging your first pull request! 🎉 We here at The InnerSource Commons are proud of you! 💖 Thank you so much for your contribution 🎁

[spier]

Thank you for following up on our conversation at the FOSS Backstage conference @fgreinacher ❤️

It is great to see how Siemens has applied some of these InnerSource patterns as well, proving that these are actually patterns i.e. solutions that are being re-discovered and applied in various different contexts and organizations.

You can now search for the InnerSource Patterns applied at Siemens through this link:
https://patterns.innersourcecommons.org/?q=Siemens

[fgreinacher]

Good idea with the linter. We have a linter (based on markdownlint) but so far that only checks for the existence of the correct section titles from our pattern template. If you are curious, see pattern-template.js.

I guess one could also check other formatting conventions there, just I have never done that before with markdown.

If you got any, I am happy for any tips related to linting documents / markdown files.

@spier We're also using https://github.com/DavidAnson/markdownlint?tab=readme-ov-file. There are many ways to run it and it can check most relevant things!