Skip to content

Level up to 2: Explicit InnerSource Principles #374

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

Merged
merged 20 commits into from
Jan 6, 2022

Conversation

spier
Copy link
Member

@spier spier commented Dec 10, 2021

Thank you again @MaineC for sharing this pattern with us.
With @gruetter's latest changes in #373, this pattern is ready for prime time (i.e. leveling it up to 'Structured' and publishing it in our book).

I made all the required changes in this PR already to do so.
Quick link to the updated pattern: here

However one last question for you:
Are you happy with the title "Explicit InnerSource Principles"?

Why am I asking?

We got another pattern in the making also using the term explicit (Explicit Shared Ownership), so I am wondering if the current title of this pattern is easy to remember and somewhat uniquely recognizeable?

Further once we publish the pattern it gets a URL at patterns.innersourcecommons.org i.e. https://patterns.innersourcecommons.org/p/explicit-innersource-principles in this case. And in order to not create any dead links we try not to change the filename and pattern name after it has been published

Your answers to this can totally be "I am happy with the title as is, let's keep it." :)
Just wanted to bring this up for your consideration.

@spier 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 Dec 10, 2021
@spier spier requested review from MaineC and gruetter and removed request for NewMexicoKid, lenucksi and cewilliams December 10, 2021 17:30
@spier
Copy link
Member Author

spier commented Dec 10, 2021

Sorry @gruetter, looks like I mentioned the wrong GitHub user first.
Do you have two just for good measure? :)

@gruetter
Copy link
Contributor

have two

not sure I get your meaning

As for the title: I'm not a fan TBPH. How about simply

  • Guiding Principles or
  • InnerSource Principles?

@gruetter
Copy link
Contributor

That said, I'm ok with the original title so I'll approve. Thanks for pushing this forward, @spier !

@claredillon
Copy link
Member

I like InnerSource principles too!

@spier
Copy link
Member Author

spier commented Dec 11, 2021

I like InnerSource principles too!

Thanks for the input @claredillon.

I am a bit wary that, as these are all InnerSource patterns, we might end up with too many things with "InnerSource" in the name. So far we only have 2 patterns like that in the book but a couple of more that are still in an initial state.

What do you think about that?

@NewMexicoKid
Copy link
Collaborator

I am a bit wary that, as these are all InnerSource patterns, we might end up with too many things with "InnerSource" in the name. So far we only have 2 patterns like that in the book but a couple of more that are still in an initial state.

What do you think about that?

I actually appreciate why you suggested explicit InnerSource principles. It seems to me to be the essence of the pattern, to not rely on people's implicit understanding of IS principles but to be explicit with them. Explicit guiding principles would also be okay (from my perspective). Just my $0.02.

@gruetter
Copy link
Contributor

Interesting point, @NewMexicoKid . The way I thought about our principles is that they start as explicit principles but become implicit over time, that's why I suggested to remove explicit. But again, I'm totally fine with the original title, even more so after your comment.

@spier
Copy link
Member Author

spier commented Dec 14, 2021

@MaineC what's your take on the discussion over the title?

  • current: Explicit InnerSource Principles
  • proposal 1: (Explicit) Guiding Principles
  • proposal 2: Document[ed] InnerSource Principles
  • proposal 3: Document[ed] Guiding Principles

I am leaning towards "Document Guiding Principles", because

  • it sounds like a "call to action" for people that want to apply the pattern
  • "Guiding" as a replacement for "InnerSource" feels more specific
  • "Document" as a replacement for "Explicit" describes the required documentation activity more specifically

Also:
In my last commit I changed the markdown formatting to 'one sentence per line' where possible. I did not change any of the content. The modified format will make reviews in the feature a bit easier.

@NewMexicoKid
Copy link
Collaborator

I am leaning towards "Document Guiding Principles"

I think if you do this, you should use Documented Guiding Principles so that people aren't confused by this pattern not being about Guiding principles for a Document (noun) vs. Document (verb) Guiding Principles.

But I think that Explicit Guiding Principles would be fine too (and maybe a little more to the point--it's not the activity itself that is needed but the fact that the principles need to be explicitly stated).

@spier
Copy link
Member Author

spier commented Dec 15, 2021

I think if you do this, you should use Documented Guiding Principles so that people aren't confused by this pattern not being about Guiding principles for a Document (noun) vs. Document (verb) Guiding Principles.

Fair point. Good idea to consider the grammar here too :)

But I think that Explicit Guiding Principles would be fine too (and maybe a little more to the point--it's not the activity itself that is needed but the fact that the principles need to be explicitly stated).

In our org the exercise of documenting such principles (or anything else) is actually the essential part. Through the documentation and review activities we bring out any disagreement or unspoken assumptions. By discussing them and resolving them we arrive at principles that we can agree on.

So if I would name the pattern after the goal, I would call it:
"Agree on Guiding Principles"

And if I would name it after the activity that gets us there
"Document your Guiding Principles" - by adding the "your" I might solve the noun/verb confusion?

But wow, naming things is really hard. Also with Patterns 🤣

@NewMexicoKid
Copy link
Collaborator

NewMexicoKid commented Dec 15, 2021 via email

@spier spier merged commit 3f34253 into main Jan 6, 2022
@spier spier deleted the level-up-innersource-principles branch January 6, 2022 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants