[do-not-merge]🎨 Add code of conduct references and template #556

rmarting · 2023-07-05T11:40:34Z

This is a proposal to extend the Standard Base Documentation pattern adding references about the Code of Conduct of an InnerSource project. This PR is to complete the issue #555.

Ready for a review for the community and get feedback.

rmarting · 2023-07-05T11:43:28Z

Requested access to this file https://docs.google.com/presentation/d/11JOByEO9QXlRLXX5BIv9rjUzPzCKErZzknD1OLcprQQ/edit?pli=1#slide=id.p to add the new assess created.

spier · 2023-07-05T12:22:31Z

hi @rmarting.

First of all, what an amazing first contribution to this repo, even containing a visual and a new template. Outstanding! Thank you so much for sharing this with us.

I read the related issue that you created and this PR.

Before going into the details of this PR, some general questions:

You mention that it is "very common to have a CODE_OF_CONDUCT.md (CoC) file as part of the repository of an InnerSource project". Would it be possible to share the names of organizations in the "Known Instances" section of the pattern that are implementing this approach? e.g. is Red Hat using this approach as well?
Personally I have not seen a CoC for InnerSource projects before. Possibly naively I would have assumed that the issues that a CoC tries to address are either less of an issue for InnerSource (as everybody is working for the same company and less anonymous than in open source), or are already covered by a general company-wide CoC that all employees accept by signing their employment contract. Curious to hear from your experience here.
The pattern we are looking to extend here is "Standard Base Documentation". Therefore I was wondering if the CoC is accepted as much as a standard as the other two files (README/CONTRIBUTING.md)? I was wondering if possible the CoC approach might benefit from being its own pattern, assuming that it addresses a very specific issue that only arrises as an organization grows beyond size x (or any other context).

Thanks again for sharing your knowledge with us, and I hope you are not disheartened by my many questions. Just trying to understand the problem+solution of the CoC approach better and help you to find the best place for sharing it within the InnerSource Commons patterns ❤️

rmarting · 2023-07-05T13:36:59Z

Hi @spier!

Thank you so much for your kindly words ... just trying to share and push some experience from my side! 😄

Some in-line comments to your questions and thoughts:

You mention that it is "very common to have a CODE_OF_CONDUCT.md (CoC) file as part of the repository of an InnerSource project". Would it be possible to share the names of organizations in the "Known Instances" section of the pattern that are implementing this approach? e.g. is Red Hat using this approach as well?

This pattern is common used in communities where I am involved, some of them promoted by Red Hat, such as:

Open Practice Library - A open community around practices to build products, and transforms teams.
Technical exercises of an DevOps Culture and Practice Enablement - Technical stuff from the Open Innovation Labs of Red Hat to promote DevOps and Agile mindset, linked to the OPL
OpenSouthCode - An event around open software and hardware with a code of conduct based in the Berlin code of conduct
Some internal communities at Red Hat

If you search CODE_OF_CONDUCT.md in GitHub, a bunch of repositories include that file, so it is a very common use case.

Personally I have not seen a CoC for InnerSource projects before. Possibly naively I would have assumed that the issues that a CoC tries to address are either less of an issue for InnerSource (as everybody is working for the same company and less anonymous than in open source), or are already covered by a general company-wide CoC that all employees accept by signing their employment contract. Curious to hear from your experience here.

From my field experience, CoC helps to create a safe space of collaboration when the community is starting inside an organization where open collaboration and sharing can be really new. It is very common in organizations with some kind of "common culture", but it is also common that each team has an specific way of working, processes, or behaviors. That "team culture" (sometimes we identify as a "Social Contract") is created by the team, and when they are opening the project, they need to share how the community should work, how the communications are expected, and how the conversations must be addressed.

If you want to success extending the social contract of the team to the rest of the organization, the CoC is a good resource. It is important describe how you are expecting your contributors, users, and community members should speak each others.

The pattern we are looking to extend here is "Standard Base Documentation". Therefore I was wondering if the CoC is accepted as much as a standard as the other two files (README/CONTRIBUTING.md)? I was wondering if possible the CoC approach might benefit from being its own pattern, assuming that it addresses a very specific issue that only arrises as an organization grows beyond size x (or any other context).

It is a good point, as I usually see as another template with the behavior, rules and constraints about the communications. However, it might be an specific pattern to address the behavior and culture of collaboration of an InnerSource project. In the end, the idea is to create a psychological safety inside the workplace. I need to think on that for a while, but it might be another approach of this concept.

In any case, the template is the best way of implementation for any InnerSource repository.

I hope my comments help you to understand better my approach. Glad to continue the conversation here or Slack to address it in the best way.

spier · 2023-07-17T15:07:03Z

@rmarting just wanted to let you know that I am afk for an extended period, and therefore cannot respond as quickly as I would normally like to.

I did see your last response though and will look through the extra material you provided.

rmarting · 2023-07-18T05:25:00Z

@spier I am jumping between PTO and active weeks, so it means a not very well focus time to close things 😄 . However I was thinking about your ideas and I can share something else.

CoC can be also identified as a pattern, but it will take me time to read and apply the instructions described in the Contributor Handbook and the pattern template. IMHO the second part will take the longer time, as the content must be aligned with that pattern. I can't give any ETA, but I will try to do my best to propose something before the end of August.

However, the templates proposed for the Standard Base Documentation are still valid and apply perfectly. The CoC pattern can extend and clarify the context of use, problem, and solution, meanwhile the CoC templates can be part of the standard base documentation for any InnerSource project.

Does it make sense?

spier · 2023-08-06T10:36:41Z

@spier I am jumping between PTO and active weeks, so it means a not very well focus time to close things 😄 . However I was thinking about your ideas and I can share something else.

CoC can be also identified as a pattern, but it will take me time to read and apply the instructions described in the Contributor Handbook and the pattern template. IMHO the second part will take the longer time, as the content must be aligned with that pattern. I can't give any ETA, but I will try to do my best to propose something before the end of August.

However, the templates proposed for the Standard Base Documentation are still valid and apply perfectly. The CoC pattern can extend and clarify the context of use, problem, and solution, meanwhile the CoC templates can be part of the standard base documentation for any InnerSource project.

Does it make sense?

@rmarting I am getting back to this PR now.

I understand the approach that you are describing above, and I am happy to follow it. Integrating the CoC into the existing pattern will give us a nice first iteration. Later on we can possibly go into greater detail by adding a dedicated pattern about the CoC approach.

Will do and end-to-end review of this PR now, with the goal of integrating it into the existing "Standard Base Documentation" pattern.

…rs to this pattern

…ons of this template to other languages would have to happen later.

…epetition and make it easier to extend in the future.

…l files from general information about how to get started with writing these files

spier

Again great work on this PR @rmarting.

I left various comments inline. If you could go through them and comment/resolve/reject as you see fit, that would be great.

I think there are only one or two places that require a bit more work but then we should be good to get this PR merged 👍

Looking forward to your feedback.

spier · 2023-07-05T11:42:36Z

patterns/2-structured/project-setup/base-documentation.md

+helps prevent and address issues such as harassment, discrimination, and toxic behavior, ensuring that
+everyone feels safe and valued within the project. By providing a framework for positive and inclusive
+participation, a Code of Conduct encourages diverse perspectives, enhances collaboration, and ultimately
+leads to the development of higher-quality open-source software.


Suggested change

leads to the development of higher-quality open-source software.

leads to the development of higher-quality InnerSource software.

spier · 2023-08-06T10:50:37Z

patterns/2-structured/project-setup/base-documentation.md

@@ -81,6 +82,18 @@ topics:

 ![CONTRIBUTING.md](../../../assets/img/standard-base-documentation/CONTRIBUTING-for-contributors.png)

+### CODE_OF_CONDUCT.md
+
+Defining a Code of Conduct within an InnerSource project is essential for fostering a welcoming and


Suggested change

Defining a Code of Conduct within an InnerSource project is essential for fostering a welcoming and

Are open collaboration and sharing really new for your organization? Does your organization consists of teams with vastly different team cultures (often happens through organization growth and acquisitions)?

In these cases defining a Code of Conduct within your InnerSource project will help to foster a welcoming and

The previous section for the CONTRIBUTING.md contains a qualifier, stating when a separate file makes sense:

If the explanation of the steps to make a contribution are too involved,

I wonder if we could add something similar to the beginning of the CODE_OF_CONDUCT.md section?

I think we could use bits and pieces from this comment of yours:

From my field experience, CoC helps to create a safe space of collaboration when the community is starting inside an organization where open collaboration and sharing can be really new. It is very common in organizations with some kind of "common culture", but it is also common that each team has an specific way of working, processes, or behaviors. That "team culture" (sometimes we identify as a "Social Contract") is created by the team, and when they are opening the project, they need to share how the community should work, how the communications are expected, and how the conversations must be addressed.

If you want to success extending the social contract of the team to the rest of the organization, the CoC is a good resource. It is important describe how you are expecting your contributors, users, and community members should speak each others.

I am leaving a proposal in the suggestion to help you understand the way that I am thinking about this. Feel free to change this entirely :)

Also if we could somehow add the "Social Contract" concept somewhere (including the link) that would be great. Maybe it is a useful exercise for a team to do, before they write their CoC?

spier · 2023-08-06T11:02:01Z

patterns/2-structured/project-setup/base-documentation.md

@@ -115,6 +133,11 @@ started right away: [README-template.md](templates/README-template.md) and

 * Isabel Drost-Fromm

+## Acknowledgments


FYI I added this Acknowledgements section, to give praise where due :)

spier · 2023-08-06T11:09:44Z

patterns/2-structured/project-setup/templates/CODE_OF_CONDUCT-template.md

@@ -0,0 +1,78 @@
+<!--


Great idea with the variables here. Nice!

spier · 2023-08-06T11:18:52Z

patterns/2-structured/project-setup/templates/CODE_OF_CONDUCT-template.md

+- {{ CommunityMail-Link }}
+-->
+
+# Code of Conduct


You mention that this template is adapted from https://www.contributor-covenant.org/version/2/1/code_of_conduct/.

Could you add some context to the major changes you made, so that I can understand why they were made?

The changes I spotted:

left away the 2nd sentence of pledge

"We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community."

renamed "Enforcement Responsibilities" to "Our Responsibilities"

left away the "Enforcement Guidelines"

I am sure I missed other changes that were made :)

spier · 2023-08-06T11:24:06Z

patterns/2-structured/project-setup/templates/CODE_OF_CONDUCT-template.md

+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, {{ Community-Name }} as


Will this sentence read correctly when the placeholder is replaced?

I tried this with the example of our own patterns community:

In the interest of fostering an open and welcoming environment, the InnerSource Patterns Community as contributor and maintainer pledge to making participation in this project a harassment-free experience for everyone, ...

I think it is the "as contributor and maintainer" that is throwing me off a bit. Not quite sure.

spier · 2023-08-06T11:31:53Z

assets/img/standard-base-documentation/README.md

@@ -4,8 +4,10 @@ The current illustration is a digital remake of this [original visual](/patterns
 If you want to edit this illustration, please request access to this [source document](https://docs.google.com/presentation/d/11JOByEO9QXlRLXX5BIv9rjUzPzCKErZzknD1OLcprQQ/edit?usp=sharing).


Do you have an email address that I can use to add you as Editor to this Google Doc?

Then we could add your illustration there, to make it easier to edit it in the future.

Also I might try to change formatting a tiny bit, to make it even more consistent with the other two visuals that we already have. (What I have in mind are coloring and centering the text below the image).

spier · 2023-08-06T11:53:37Z

You mention that it is "very common to have a CODE_OF_CONDUCT.md (CoC) file as part of the repository of an InnerSource project". Would it be possible to share the names of organizations in the "Known Instances" section of the pattern that are implementing this approach? e.g. is Red Hat using this approach as well?

This pattern is common used in communities where I am involved, some of them promoted by Red Hat, such as:

Open Practice Library - A open community around practices to build products, and transforms teams.

Technical exercises of an DevOps Culture and Practice Enablement - Technical stuff from the Open Innovation Labs of Red Hat to promote DevOps and Agile mindset, linked to the OPL

OpenSouthCode - An event around open software and hardware with a code of conduct based in the Berlin code of conduct

Some internal communities at Red Hat

If you search CODE_OF_CONDUCT.md in GitHub, a bunch of repositories include that file, so it is a very common use case.

@rmarting just one additional comment on top of what I already left in the review on this PR.

The examples of CoCs above are all from open source projects, aren't they?

I was wondering if you know examples of CoCs used in an InnerSource context? Maybe sharing non-confidential information about the "Some internal communities at Red Hat" could help, as that sounds like an InnerSource implementation of the CoC concept?

Also if Red Hat has an InnerSource application of this pattern, then we could include Red Hat as a known instance in this pattern as well, which would be extra sweet :)

spier · 2023-08-17T08:25:24Z

@rmarting thanks again for sharing your experience with us.

I remember you mentioned toggling between PTO and active weeks.
So I was wondering if there is anything else I can do to help make things easier for you, on top of the review and comments that I left on the PR?

Thanks again, and no rush. Just want to make sure that we are providing everything that you need as contributor.

spier · 2023-09-14T19:37:00Z

#589 introduced some changes to the same pattern. I need to merge those in and resolve conflicts, to get this branch into a mergeable state again.

mcobby · 2024-02-28T05:21:20Z

You mention that it is "very common to have a CODE_OF_CONDUCT.md (CoC) file as part of the repository of an InnerSource project". Would it be possible to share the names of organizations in the "Known Instances" section of the pattern that are implementing this approach? e.g. is Red Hat using this approach as well?

I had a CoC as a minimum standard in repositories at National Australia Bank and it was in our template repo. It was at the time that conferences started to become very visible with having a CoC. I can't say it was very successful in it's adoption.

Personally I have not seen a CoC for InnerSource projects before. Possibly naively I would have assumed that the issues that a CoC tries to address are either less of an issue for InnerSource (as everybody is working for the same company and less anonymous than in open source), or are already covered by a general company-wide CoC that all employees accept by signing their employment contract. Curious to hear from your experience here.

In a larger enterprise, the size is so big that you don't see over the horizon and there are many teams you don't know about. Yes, there is a general expectation of employee conduct and HR has processes for that. Teams develop their own sub-cultures and it helps to address that. We were doing a lot of work on diversity and we wanted to create an environment where every voice is heard, not always the case in companies with "confident" male engineers.

The pattern we are looking to extend here is "Standard Base Documentation". Therefore I was wondering if the CoC is accepted as much as a standard as the other two files (README/CONTRIBUTING.md)? I was wondering if possible the CoC approach might benefit from being its own pattern, assuming that it addresses a very specific issue that only arrises as an organization grows beyond size x (or any other context).

I agree that it is a pattern with a specific use case, also a template example in the pattern to get started.

rmarting · 2024-02-28T07:00:47Z

Hi Team! Sorry for being a bit absent here for a while, however I would like to share that I was working on the idea of a new pattern to describe the CoC. And I found it very useful to describe why CoC is important for an InnerSource community. At Red Hat we usually add it (as part of the project scaffolding) using the Contributor Covenant as baseline, and allowing each community to add it to its own rules. At Red Hat, and from my experience with some teams, the CoC helps to define the rules of communication and behavior of the community and allow healthy conversations, reducing conflicts and misunderstandings.

At this point, I am drafting the CoC pattern (following the instructions for that) and I want to push the PR no longer that this week. It took some time for me to understand the structure, and rules to propose a new one... but now I am ready to go.

As I see it, publishing a CoC pattern and its use cases properly can be the first step, and secondly extend the Base Standard Documentation Pattern with a sample (based on the Contributor Covenant) as a starting point for new adopters.

PS: I need to check the status of this PR and fix the conflicts.

Sustainable InnerSource Program - donut pattern --------- Co-authored-by: Chan Voong <[email protected]> Co-authored-by: Chan Voong <[email protected]>

* Updating CODEOWNERS file * Writing updated toc.md for the pt-br book * Re-creating markmap and screenshot

Add Airbus as a "known instance" to multiple patterns

…SourceCommons#532) * Added Robert Bosch GmbH as Known Instance * Add another force related to possible relicensing when moved from InnerSource to open source * Reformatting pattern, to include Airbus reference (pulled in via last update from main) --------- Co-authored-by: Sebastian Spier <[email protected]>

* Adding Patterns WG board report 2023-11

…#633) * Move files from project-setup to standard folders * Fix all links from patterns to project-setup folder * Fix all links from translations to project-setup folder * Remove instances of project/setup in book and scripts * Point from old project-setup folder to the new folder for these files * Regenerate en toc.me locally. Not sure why the GHA did not do this.

…Commons#635)

…mons#637) Add wiki implementation of InnerSource portal pattern. To structure the information more clearly, this adds a new "Implementation" section to this pattern, which complements the "Solution" and "Known Instances" section.

Add alt text https://github.com/InnerSourceCommons/InnerSourcePatterns/actions/runs/7386496303/job/20093212394

…nnerSourceCommons#653)

…l files from general information about how to get started with writing these files

rmarting · 2024-02-29T10:15:35Z

@spier After merging/rebasing the latest changes, this PR is so huge to be reviewed successfully. So, I will create a new one for the Code of Conduct pattern, and after that a new one with the extension of this pattern with the templates. Both PRs will be aligned with the latest status of the main branch, and avoid to have one like this.

For now, could we could just add a label or mark it as DO-NOT-MERGE? just to have the conversation open until the new PRs are closed. Thanks

spier · 2024-02-29T17:10:31Z

Added the "[do-not-merge]" to the title and also converted the PR into a draft.

Happy to keep the PR open as a reference as well.
However even if we close this PR, we can still access all comments and even continue commenting here if we like. So really up to us whether we want to have this PR in open or closed state.

And thanks again for pushing this topic forward @rmarting!

spier · 2024-06-15T08:12:46Z

We decided to add this content as a separate pattern via #661, rather than adding it to the (already large) Standard Base Documentation pattern.

Closing this PR.

🎨 Add code of conduct references and template

3f64faf

rmarting requested review from lenucksi, NewMexicoKid, cewilliams, spier and robtuley as code owners July 5, 2023 11:40

rmarting added 3 commits July 5, 2023 13:46

💚 Update broken urls from Storyset

7062676

✏️ Remove trailing spaces

8201199

💚 Link to the correct file

23e739e

spier added 2-structured Patterns with existing instances (Please see our contribution handbook for details) 📖 Type - Content Work Working on contents is the main focus of this issue / PR labels Jul 5, 2023

spier added 3 commits August 6, 2023 12:59

Adding Acknowledgments section to attribute the additional contributo…

4c2d80a

…rs to this pattern

Change the order of acknowledgements

03b6349

Adding CoC template to the menu in the rendered book. Note: Translati…

5300514

…ons of this template to other languages would have to happen later.

spier requested a review from yuhattor as a code owner August 6, 2023 11:28

spier added 2 commits August 6, 2023 13:39

We are adding another template now. Simplifying the text to prevent r…

dd8f50f

…epetition and make it easier to extend in the future.

Adding a new sub-section to separate the explanation of the individua…

03e3366

…l files from general information about how to get started with writing these files

spier requested changes Aug 6, 2023

View reviewed changes

RishiCharavada mentioned this pull request Oct 3, 2023

Added CODE_OF_CONDUCT.md #592

Closed

spier and others added 20 commits February 29, 2024 10:55

Add pt-br and gl to the translation consistency check

372fe51

Add maintainer section, related to translations

c67c963

Explain how to regenerate the mindmap for different languages

04517fb

Add basic documentation about translating visuals. extend mainter docs.

ea2d200

Remove duplicated files. Script is run from parent folder.

7e7e9ca

Sustainable InnerSource donut pattern (InnerSourceCommons#453)

d51ee79

Sustainable InnerSource Program - donut pattern --------- Co-authored-by: Chan Voong <[email protected]> Co-authored-by: Chan Voong <[email protected]>

Add files for mindmap in pt-br (InnerSourceCommons#620)

02e72a2

Test regeneration of pt-br mindmap (InnerSourceCommons#621)

35119cf

* Updating CODEOWNERS file * Writing updated toc.md for the pt-br book * Re-creating markmap and screenshot

Airbus pattern use (InnerSourceCommons#622)

78cf635

Add Airbus as a "known instance" to multiple patterns

Adding Patterns WG board report 2023-11 (InnerSourceCommons#626)

378a0e0

* Adding Patterns WG board report 2023-11

improved review committee pattern InnerSourceCommons#634 (InnerSource…

e70a825

…Commons#635)

Fix Markdown Lint error (InnerSourceCommons#644)

2a953c7

Add alt text https://github.com/InnerSourceCommons/InnerSourcePatterns/actions/runs/7386496303/job/20093212394

Fix wording in transitioning-contractor-code-to-innersource-model.md (I…

95b3fca

…nnerSourceCommons#653)

🎨 Add code of conduct references and template

04c7606

🔀 Merge latest changes

dec748e

🔀 Fix merge conflict

cfd502b

Adding a new sub-section to separate the explanation of the individua…

3fc02bd

…l files from general information about how to get started with writing these files

rmarting requested review from jrcosta, zilio and WillemJiang as code owners February 29, 2024 09:59

spier changed the title ~~🎨 Add code of conduct references and template~~ [do-not-merge]🎨 Add code of conduct references and template Feb 29, 2024

spier marked this pull request as draft February 29, 2024 17:08

rmarting mentioned this pull request Mar 5, 2024

New Pattern: Code of Conduct #661

Merged

spier closed this Jun 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[do-not-merge]🎨 Add code of conduct references and template #556

[do-not-merge]🎨 Add code of conduct references and template #556

rmarting commented Jul 5, 2023

rmarting commented Jul 5, 2023

spier commented Jul 5, 2023

rmarting commented Jul 5, 2023

spier commented Jul 17, 2023

rmarting commented Jul 18, 2023

spier commented Aug 6, 2023

spier left a comment

spier Jul 5, 2023

spier Aug 6, 2023

spier Aug 6, 2023

spier Aug 6, 2023

spier Aug 6, 2023

spier Aug 6, 2023

spier Aug 6, 2023

spier commented Aug 6, 2023 •

edited

Loading

spier commented Aug 17, 2023

spier commented Sep 14, 2023

mcobby commented Feb 28, 2024

rmarting commented Feb 28, 2024

rmarting commented Feb 29, 2024

spier commented Feb 29, 2024

spier commented Jun 15, 2024

	leads to the development of higher-quality open-source software.
	leads to the development of higher-quality InnerSource software.

-Defining a Code of Conduct within an InnerSource project is essential for fostering a welcoming and
+Are open collaboration and sharing really new for your organization? Does your organization consists of teams with vastly different team cultures (often happens through organization growth and acquisitions)?
+In these cases defining a Code of Conduct within your InnerSource project will help to foster a welcoming and

		@@ -115,6 +133,11 @@ started right away: [README-template.md](templates/README-template.md) and

		* Isabel Drost-Fromm

		## Acknowledgments


		## Our Pledge

		In the interest of fostering an open and welcoming environment, {{ Community-Name }} as

		@@ -4,8 +4,10 @@ The current illustration is a digital remake of this [original visual](/patterns
		If you want to edit this illustration, please request access to this [source document](https://docs.google.com/presentation/d/11JOByEO9QXlRLXX5BIv9rjUzPzCKErZzknD1OLcprQQ/edit?usp=sharing).

[do-not-merge]🎨 Add code of conduct references and template #556

[do-not-merge]🎨 Add code of conduct references and template #556

Conversation

rmarting commented Jul 5, 2023

rmarting commented Jul 5, 2023

spier commented Jul 5, 2023

rmarting commented Jul 5, 2023

spier commented Jul 17, 2023

rmarting commented Jul 18, 2023

spier commented Aug 6, 2023

spier left a comment

Choose a reason for hiding this comment

spier Jul 5, 2023

Choose a reason for hiding this comment

spier Aug 6, 2023

Choose a reason for hiding this comment

spier Aug 6, 2023

Choose a reason for hiding this comment

spier Aug 6, 2023

Choose a reason for hiding this comment

spier Aug 6, 2023

Choose a reason for hiding this comment

spier Aug 6, 2023

Choose a reason for hiding this comment

spier Aug 6, 2023

Choose a reason for hiding this comment

spier commented Aug 6, 2023 • edited Loading

spier commented Aug 17, 2023

spier commented Sep 14, 2023

mcobby commented Feb 28, 2024

rmarting commented Feb 28, 2024

rmarting commented Feb 29, 2024

spier commented Feb 29, 2024

spier commented Jun 15, 2024

spier commented Aug 6, 2023 •

edited

Loading