From e0ecdbaa07765ac2c501dcbbe3354781e3017e5b Mon Sep 17 00:00:00 2001 From: Tom Sadler Date: Sun, 30 Jan 2022 20:07:46 +0000 Subject: [PATCH 01/13] Initial FAQ commit --- introduction/07-faq.asciidoc | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 introduction/07-faq.asciidoc diff --git a/introduction/07-faq.asciidoc b/introduction/07-faq.asciidoc new file mode 100644 index 00000000..518e40a3 --- /dev/null +++ b/introduction/07-faq.asciidoc @@ -0,0 +1,15 @@ +== FAQ + +To conclude the Introduction segment of the Learning Path, here are some Frequently Asked Questions people have when embarking on their InnerSource journey. + +=== What is the cost/overhead? + +=== Why not just open source? + +=== Will this slow us down? + +=== Will we just be reviewing PRs all day every day? + +=== How do we convince management this is a good idea? + +=== How do we convince engineers this is a good idea? \ No newline at end of file From 8af14f2dc69f03eff53ae61140f9c088b831a6c0 Mon Sep 17 00:00:00 2001 From: Tom Sadler Date: Sun, 20 Feb 2022 21:04:31 +0000 Subject: [PATCH 02/13] Update introduction/07-faq.asciidoc Co-authored-by: rrrutledge --- introduction/07-faq.asciidoc | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/introduction/07-faq.asciidoc b/introduction/07-faq.asciidoc index 518e40a3..6fd4fa8a 100644 --- a/introduction/07-faq.asciidoc +++ b/introduction/07-faq.asciidoc @@ -12,4 +12,10 @@ To conclude the Introduction segment of the Learning Path, here are some Frequen === How do we convince management this is a good idea? -=== How do we convince engineers this is a good idea? \ No newline at end of file +=== How do we convince engineers this is a good idea? + +=== What are the expectations on part of both host and contributor? + +=== How will we maintain control of the project? + +=== How do we get people to make contributions? \ No newline at end of file From ffd548a5a888de094da7bb0011f2f37a8fc618b0 Mon Sep 17 00:00:00 2001 From: Tom Sadler Date: Sun, 20 Feb 2022 21:26:28 +0000 Subject: [PATCH 03/13] Split overhead question into 2 - maintainer and contributor --- introduction/07-faq.asciidoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/introduction/07-faq.asciidoc b/introduction/07-faq.asciidoc index 6fd4fa8a..572aac1c 100644 --- a/introduction/07-faq.asciidoc +++ b/introduction/07-faq.asciidoc @@ -2,7 +2,9 @@ To conclude the Introduction segment of the Learning Path, here are some Frequently Asked Questions people have when embarking on their InnerSource journey. -=== What is the cost/overhead? +=== What is the cost/overhead of maintaining an InnerSource projects? + +=== What is the cost/overhead of contributing to an InnerSource projects? === Why not just open source? From 0e4a7d0a88dfae20331af1a86b47e3b1ba80eef2 Mon Sep 17 00:00:00 2001 From: Tom Sadler Date: Sat, 2 Jul 2022 21:50:57 +0100 Subject: [PATCH 04/13] First pass at answering some FAQs following PR comments --- introduction/07-faq.asciidoc | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/introduction/07-faq.asciidoc b/introduction/07-faq.asciidoc index 572aac1c..fbd7854c 100644 --- a/introduction/07-faq.asciidoc +++ b/introduction/07-faq.asciidoc @@ -7,12 +7,21 @@ To conclude the Introduction segment of the Learning Path, here are some Frequen === What is the cost/overhead of contributing to an InnerSource projects? === Why not just open source? +By all means do so if the project makes sense! Some projects are specific to your company or are a competitive advantage, so you'll want to keep those as InnerSource. Some need to iterate more quickly than can be done in the open. + +If your organisation isn't familiar with running open source projects, InnerSource can help people learn the skills required with a view to open sourcing in the future. === Will this slow us down? +It depends on how far you're going. You'll probably be going a lot further than you think. +![If you want to go fast, go alone. If you want to go far, go together](https://user-images.githubusercontent.com/9609562/151901209-52b3468b-dedd-4319-9ca3-38b6b2bcfaf5.png) === Will we just be reviewing PRs all day every day? +If so then your core team is understaffed. A healthy team is staffed so that there is time for assisting contributors and making core contributions yourself. + +You can mitigate this by setting expectation, potentialy via SLAs. If contributors expect PR reviews within an hour, maybe you will be stuck reviewing PRs all the time, but if you set an SLA of 1 day or 1 week, this won't be the case. === How do we convince management this is a good idea? +Figure out what they want and get a working example of InnerSource, preferably within your organisation, that shows them getting it. === How do we convince engineers this is a good idea? From 478c3782c0ad20dabe5ab2879e84361ba62df6d8 Mon Sep 17 00:00:00 2001 From: Tom Sadler Date: Tue, 12 Jul 2022 13:34:37 +0100 Subject: [PATCH 05/13] asciidoc image syntax Co-authored-by: rrrutledge --- introduction/07-faq.asciidoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/introduction/07-faq.asciidoc b/introduction/07-faq.asciidoc index fbd7854c..f63b98ba 100644 --- a/introduction/07-faq.asciidoc +++ b/introduction/07-faq.asciidoc @@ -13,7 +13,8 @@ If your organisation isn't familiar with running open source projects, InnerSour === Will this slow us down? It depends on how far you're going. You'll probably be going a lot further than you think. -![If you want to go fast, go alone. If you want to go far, go together](https://user-images.githubusercontent.com/9609562/151901209-52b3468b-dedd-4319-9ca3-38b6b2bcfaf5.png) + +image::https://user-images.githubusercontent.com/9609562/151901209-52b3468b-dedd-4319-9ca3-38b6b2bcfaf5.png[If you want to go fast, go alone. If you want to go far, go together] === Will we just be reviewing PRs all day every day? If so then your core team is understaffed. A healthy team is staffed so that there is time for assisting contributors and making core contributions yourself. From b620072deccb16419ba58fc9ec9e03a83c5ded6d Mon Sep 17 00:00:00 2001 From: Tom Sadler Date: Tue, 12 Jul 2022 13:54:53 +0100 Subject: [PATCH 06/13] Answer cost/overhead questions --- introduction/07-faq.asciidoc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/introduction/07-faq.asciidoc b/introduction/07-faq.asciidoc index f63b98ba..d9152fd1 100644 --- a/introduction/07-faq.asciidoc +++ b/introduction/07-faq.asciidoc @@ -3,8 +3,15 @@ To conclude the Introduction segment of the Learning Path, here are some Frequently Asked Questions people have when embarking on their InnerSource journey. === What is the cost/overhead of maintaining an InnerSource projects? +It depends! An InnerSource project that encourages small pull requests and has clear contribution guidelines may require very little overhead, with most of the work being code reviews. To learn more about practices that can reduce the overheard of maintaining InnerSource projects, we suggest you look at the https://patterns.innersourcecommons.org/[InnerSource Patterns], especially: + +* https://patterns.innersourcecommons.org/p/30-day-warranty[30 Day Warranty] +* https://patterns.innersourcecommons.org/p/service-vs-library[Service vs. Library] +* https://patterns.innersourcecommons.org/p/base-documentation[Standard Base Documentation] +* https://patterns.innersourcecommons.org/p/trusted-committer[Trusted Committer] === What is the cost/overhead of contributing to an InnerSource projects? +50% more effort to commit. 100% less effort to maintain. === Why not just open source? By all means do so if the project makes sense! Some projects are specific to your company or are a competitive advantage, so you'll want to keep those as InnerSource. Some need to iterate more quickly than can be done in the open. From a9b1f53e0d7a301380e76340f50d20e39a2759c0 Mon Sep 17 00:00:00 2001 From: Tom Sadler Date: Tue, 12 Jul 2022 14:01:24 +0100 Subject: [PATCH 07/13] Answer 'How do we convince engineers this is a good idea?' --- introduction/07-faq.asciidoc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/introduction/07-faq.asciidoc b/introduction/07-faq.asciidoc index d9152fd1..25110293 100644 --- a/introduction/07-faq.asciidoc +++ b/introduction/07-faq.asciidoc @@ -32,6 +32,13 @@ You can mitigate this by setting expectation, potentialy via SLAs. If contributo Figure out what they want and get a working example of InnerSource, preferably within your organisation, that shows them getting it. === How do we convince engineers this is a good idea? +InnerSource gives engineers the opportunity to develop their career, both in terms of skills and https://patterns.innersourcecommons.org/p/praise-participants[recognition] within their organisation: + +* Broadens their skillset by contributing to different projects, or even different tech stacks! +* Scales the value they add to the organisation, by having their software run by more people +* Opportunity to network and collaborate with others in their organisation that they wouldn't normally + +Also, many engineers value open source; InnerSource embraces open source practices, and can be a step towards open source for many projects. === What are the expectations on part of both host and contributor? From d4f5177c1b04138c204b2631e38472b56e3e808c Mon Sep 17 00:00:00 2001 From: Tom Sadler Date: Tue, 12 Jul 2022 14:08:20 +0100 Subject: [PATCH 08/13] Answer 'What are the expectations on part of both host and contributor?' --- introduction/07-faq.asciidoc | 1 + 1 file changed, 1 insertion(+) diff --git a/introduction/07-faq.asciidoc b/introduction/07-faq.asciidoc index 25110293..6cd539d0 100644 --- a/introduction/07-faq.asciidoc +++ b/introduction/07-faq.asciidoc @@ -41,6 +41,7 @@ InnerSource gives engineers the opportunity to develop their career, both in ter Also, many engineers value open source; InnerSource embraces open source practices, and can be a step towards open source for many projects. === What are the expectations on part of both host and contributor? +Work together! This may be completely async via Pull Requests, or invovle regular community catchups - whatever works for you. Communication and support must go in both directions and be open and collaborative. === How will we maintain control of the project? From ce0f1b94f05f3367fb6f5c02090225f46730148f Mon Sep 17 00:00:00 2001 From: Tom Sadler Date: Tue, 12 Jul 2022 14:13:11 +0100 Subject: [PATCH 09/13] Answer 'How will we maintain control of the project?' --- introduction/07-faq.asciidoc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/introduction/07-faq.asciidoc b/introduction/07-faq.asciidoc index 6cd539d0..e810fe21 100644 --- a/introduction/07-faq.asciidoc +++ b/introduction/07-faq.asciidoc @@ -44,5 +44,11 @@ Also, many engineers value open source; InnerSource embraces open source practic Work together! This may be completely async via Pull Requests, or invovle regular community catchups - whatever works for you. Communication and support must go in both directions and be open and collaborative. === How will we maintain control of the project? +By setting clear contribution guidelines, and being transparent on the direction of the project. Some Patterns that may help: + +* https://patterns.innersourcecommons.org/p/issue-tracker[Issue Tracker Use Cases] +* https://patterns.innersourcecommons.org/p/base-documentation[Standard Base Documentation] +* https://patterns.innersourcecommons.org/p/transparent-cross-team-decision-making-using-rfcs[Transparent Cross-Team Decision Making using RFCs] + === How do we get people to make contributions? \ No newline at end of file From f5418e9b6281bc029a4bdb62b5489116b31e82a6 Mon Sep 17 00:00:00 2001 From: Tom Sadler Date: Tue, 12 Jul 2022 14:27:41 +0100 Subject: [PATCH 10/13] Answer 'How do we get people to make contributions?' --- introduction/07-faq.asciidoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/introduction/07-faq.asciidoc b/introduction/07-faq.asciidoc index e810fe21..c7b65df8 100644 --- a/introduction/07-faq.asciidoc +++ b/introduction/07-faq.asciidoc @@ -51,4 +51,5 @@ By setting clear contribution guidelines, and being transparent on the direction * https://patterns.innersourcecommons.org/p/transparent-cross-team-decision-making-using-rfcs[Transparent Cross-Team Decision Making using RFCs] -=== How do we get people to make contributions? \ No newline at end of file +=== How do we get people to make contributions? +Your team and wider organisation's culture must value collaboration. Focus on the business value - teams are able to unblock themselves where software they use have bugs or are missing required features. Where contributors have no immediate business need, you can [https://patterns.innersourcecommons.org/p/gig-marketplace]advertise you are looking for help. \ No newline at end of file From 0f1e46c65aae62a67e74d850d37ff732b8ff7605 Mon Sep 17 00:00:00 2001 From: Tom Sadler Date: Tue, 12 Jul 2022 15:38:54 +0100 Subject: [PATCH 11/13] Updates based on feedback in PR --- introduction/07-faq.asciidoc | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/introduction/07-faq.asciidoc b/introduction/07-faq.asciidoc index c7b65df8..8bd4a596 100644 --- a/introduction/07-faq.asciidoc +++ b/introduction/07-faq.asciidoc @@ -41,10 +41,14 @@ InnerSource gives engineers the opportunity to develop their career, both in ter Also, many engineers value open source; InnerSource embraces open source practices, and can be a step towards open source for many projects. === What are the expectations on part of both host and contributor? -Work together! This may be completely async via Pull Requests, or invovle regular community catchups - whatever works for you. Communication and support must go in both directions and be open and collaborative. +Work together! This may be completely async via Pull Requests, or invovle regular community catchups - whatever works for you. + +Communication and support must go in both directions and be open and collaborative, fostering a culture of psychological safety. Feedback on contributions, or existing code, must be approached with a growth mindset, and as partnership to make things better. === How will we maintain control of the project? -By setting clear contribution guidelines, and being transparent on the direction of the project. Some Patterns that may help: +Through the Trusted Committer and Product Owner roles you can still ensure that the incoming code is a good fit from both a product and engineering perspective. You do not have to merge code that is not a good fit. + +You should also set clear contribution guidelines, and be transparent on the direction of the project. Some Patterns that may help: * https://patterns.innersourcecommons.org/p/issue-tracker[Issue Tracker Use Cases] * https://patterns.innersourcecommons.org/p/base-documentation[Standard Base Documentation] From f20622dd009a06c27fb01164622205d8fa1dd4d9 Mon Sep 17 00:00:00 2001 From: Tom Sadler Date: Sun, 17 Jul 2022 22:50:16 +0100 Subject: [PATCH 12/13] Update introduction/07-faq.asciidoc Co-authored-by: rrrutledge --- introduction/07-faq.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/introduction/07-faq.asciidoc b/introduction/07-faq.asciidoc index 8bd4a596..1e7fe236 100644 --- a/introduction/07-faq.asciidoc +++ b/introduction/07-faq.asciidoc @@ -56,4 +56,4 @@ You should also set clear contribution guidelines, and be transparent on the dir === How do we get people to make contributions? -Your team and wider organisation's culture must value collaboration. Focus on the business value - teams are able to unblock themselves where software they use have bugs or are missing required features. Where contributors have no immediate business need, you can [https://patterns.innersourcecommons.org/p/gig-marketplace]advertise you are looking for help. \ No newline at end of file +Your team and wider organisation's culture must value collaboration. Focus on the business value - teams are able to unblock themselves where software they use have bugs or are missing required features. Where contributors have no immediate business need, you can https://patterns.innersourcecommons.org/p/gig-marketplace[advertise] you are looking for help. \ No newline at end of file From 05940edfcdbc093fa7c2d92b956bf20b45a7ade2 Mon Sep 17 00:00:00 2001 From: Tom Sadler Date: Tue, 26 Jul 2022 17:09:04 +0100 Subject: [PATCH 13/13] Incoirporate suggestions for 'How do we convince management this is a good idea?' --- introduction/07-faq.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/introduction/07-faq.asciidoc b/introduction/07-faq.asciidoc index 1e7fe236..4d77f531 100644 --- a/introduction/07-faq.asciidoc +++ b/introduction/07-faq.asciidoc @@ -29,7 +29,7 @@ If so then your core team is understaffed. A healthy team is staffed so that the You can mitigate this by setting expectation, potentialy via SLAs. If contributors expect PR reviews within an hour, maybe you will be stuck reviewing PRs all the time, but if you set an SLA of 1 day or 1 week, this won't be the case. === How do we convince management this is a good idea? -Figure out what they want and get a working example of InnerSource, preferably within your organisation, that shows them getting it. +Figure out what they want and get a https://innersourcecommons.org/stories[working example of InnerSource], preferably within your organisation, that shows them getting it. If your organization's OSPO manages innersource projects, reach out to them for support. === How do we convince engineers this is a good idea? InnerSource gives engineers the opportunity to develop their career, both in terms of skills and https://patterns.innersourcecommons.org/p/praise-participants[recognition] within their organisation: