Merge branch 'master' into adding-pattern-evidence

Author: lenucksi

meta/boardreports/2020-10-details.md

@@ -0,0 +1,52 @@
+# InnerSource Patterns WG - Report for governance meeting 2020-10
+
+**Details Section**
+ 
+## Project Activity - Describe the overall activity in the project over the past quarter.
+
+Here are some more detailed numbers as mentioned in short-form.
+
+### Pattern-work
+
+#### Entirely new & merged: 5
+
+- RFCs #204 @tsadler1988 @spier @mainec 
+- InnerSource Activity Score @michadelic SAP #189 @newmexicokid @spier
+- InnerSource License #147
+- Pattern Overview Mindmap: @feiwan2000 (very popular!) 
+- Europace sponsored: Mechanics and tooling recommendations #124, #123 #121 @mainec @rrutledge @martinklewitz @newmexicokid @sjn
+
+#### Entirely new & open: 2
+
+- #166 concept-anchor @mishari
+- #182 definition of OSS/ISS projects @chtompki
+
+#### Existing PRs/Content merged: 3
+
+- Maturity model #121 @mainec @dizquierdo
+- Draft from Galway "Who is using my code" #112 @StingrayZA
+- Reluctance to accept contributions #199 from GDoc via @spier from Klaas & others (see pattern)
+
+#### Progress on existing PRs: 8
+
+- #95 (almost done, @gruetter), #46 (#216, @gruetter) #120 #84 #78 #74 #71 #64 
+
+### Technical contributions: about 8
+
+- Content linting #168, #222, @spier, @nschonni
+- rendering to Gitbook @217 @spier
+- linkchecking #157 @spier #146 #145
+
+### Cleanup, Fixing & Migration: a lot
+
+- Fixing countless typos, broken links and inconsistent templates/documentation: @spier 
+- Spelling, typos, examples #176, #175 @jpatrao
+- Typos, small improvements @stingrayza, @michadelic @funzinator
+
+### General statistics
+
+- PRs closed: 23
+- PRs created: 19
+- Open PRs (end of quarter): 20
+- Open Issues (end of quarter): 27
+- trusted committers: 5 (active ~3)

meta/boardreports/2020-10.md

@@ -0,0 +1,68 @@
+# InnerSource Patterns WG - Report for governance meeting 2020-10
+
+**Data from June to September**
+
+## Mission - Briefly describe what your project actually does.
+
+- Discuss community InnerSource practices and dynamics, collect and document agreed upon best practices of how to do InnerSource - in the form of patterns
+- Continuously publish the most mature patterns as an ebook and website
+
+## Project/Community Status and Health - Sum up the status and health of your project and community in a few sentences
+
+- This project is seeing more activity than ~1 year ago, with 10 new contributors, some of them repeatedly, some major contributions, lots of evolutionary improvements. Also new contributions from past contributors.
+- Activity and trusted committer diversity is still too low to sustain the project in the long run on a high activity level. Low activity evolution is sustainable.
+
+## Project Activity - Describe the overall activity in the project over the past quarter.
+
+- New process proposal by @maxcapraro, discussion (@spier @mainec @newmexicokid @lenucksi) and successful adoption (initial, structured, validated, goal: faster first contribution, see contributor handbook)
+- Processing of existing content from wiki and existing PRs into publishable repo content, large scale cleanup, migration and fixing, all ongoing for the foreseeable future. 
+- Great work towards content rendering (e.g. website, initial PDFs) in progress @spier @dizquerdo (https://innersourcecommons.gitbook.io/innersource-patterns-staging/v/book/)
+- Conference activity, more, interesting pattern activity on Slack leading to new patterns 
+- Patterns office-hours concept try out, some success, dual time-zone meeting concept successfully in use in marketing wg
+
+### Pattern-work
+
+- This is condensed overview. See [details](2020-10-details.md) for details with contributors.
+- Entirely new & merged: 5
+- Entirely new & open: 2
+- Existing PRs/Content merged: 3
+- Progress on existing PRs: 8
+- Technical contributions: ca. 8
+- Cleanup, Fixing & Migration: a lot
+- Trusted committers: 5 (active ~3)
+
+## Plans of the Project
+
+**Describe the current plans of the project. Include goals the project is working towards as well as any announcements that should be published through the marketing group.**
+
+- Publish our first official ebook of the InnerSource patterns. Once we do that, let’s announce that through our Marketing WG.
+- Process existing content from pull requests and Google group into our repository
+- Evaluate ideas to further facilitate collection of pattern content (e.g. through automation), channel ongoing discussions into pattern-work and attract more contributors, e.g. by lowering the barriers of entry for them.
+- Onboard further trusted committers
+- Possibly review the current list of trusted committers. Some of them don’t seem to be active anymore (likely they receive a lot of github/email spam from us today).
+
+## Last Committer Addition
+
+**When was the last committer added to the project? A healthy project tends to add new committers regularly. The report should indicate the most recent date on which a committer was added.**
+
+- 24th of April 2020: @lenucksi
+
+## Committer Diversity
+
+**Cover committer diversity in your project. A healthy project should survive the departure of any single contributor or employer of contributors. What are your steps to make sure that people from all regions on the globe can participate in your project without having to be awake at midnight their local time?**
+
+- Focus on asynchronous collab in the #innersource-patterns channel
+- Offering of office hours on APAC and EU/Americas friendly timeslots
+- Work towards automation of administration tasks, documentation of processes
+- Have TCs in multiple time zones
+
+## Legal Issues & Other Needs
+
+**Are there any project branding or naming issues, either in the project or externally? Any legal issues? Any infrastructure or strategic needs?**
+
+- None currently, book illustrations will trigger IP compliance requirements.
+- Suggestions welcome on how to attract more contributors.
+
+## Any issues for the Board to act on?
+
+- None

meta/boardreports/2020-11.md

@@ -0,0 +1,82 @@
+# InnerSource Patterns WG - Report for Governance Meeting 2020-11
+
+**Reporting Period:** October 10/2020 (since [previous report](2020-10.md))
+
+**Important Note:** Some interesting activity in the Patterns WG in November 2020, especially related to categorizing patterns according to their phases in an InnerSource Program to improve discoverability. As this work happened outside of the reporting period it will be highlighted in the next report.
+
+## Mission
+
+*Briefly describe what your project actually does.*
+
+- Discuss community InnerSource practices and dynamics, collect and document agreed upon best practices of how to do InnerSource - in the form of patterns
+- Continuously publish the most mature patterns as an ebook and website
+
+## Project/Community Status and Health
+
+*Sum up the status and health of your project and community in a few sentences*
+
+- 1 new contributor in the reporting period (@WillemJiang)
+- Challenges:
+	- PRs with minor changes stay open for extended periods. This prevents quick incremental quality improvements. This might also demotivate contributors, as giving them a sense of success would be a way to keep them engaged in the project. Examples: [#213](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/213), [#222](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/222), [#230](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/230), [#232](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/232) 
+	- Also the longer a PR stays open, the higher the chances that that PR will go stale i.e. the author does not have time anymore to see the PR through. Examples of said risk are [13 PRs](https://github.com/InnerSourceCommons/InnerSourcePatterns/pulls?q=is%3Apr+is%3Aopen+created%3A%3C2020) that have been created prior to 2020, many even in 2017. Bringing these PRs to a stage where they can either be discontinued (i.e. closed) or approved+merged has proven difficult.
+- Activity and trusted committer diversity is too low to sustain the project in the long run on a high activity level. (Low activity evolution is sustainable.)
+
+## Project Activity
+
+*Describe the overall activity in the project over the reporting period.*
+
+- Continuing to work with the new Maturity levels (initial, structured, validated)
+- Continuing work towards [content rendering](https://innersourcecommons.gitbook.io/innersource-patterns/v/book/) (e.g. website, initial PDFs) @spier
+- Presentation pitch for upcoming APAC Summit: *Level up your InnerSource through Patterns* - @fwan2000, @spier
+- Patterns office-hours concept try out, some success, dual time-zone meeting concept successfully in use in Marketing WG
+
+### Pattern-work
+
+* [Merged PRs](https://github.com/InnerSourceCommons/InnerSourcePatterns/pulls?q=is%3Apr+closed%3A2020-10-01..2020-10-31+is%3Amerged): 2
+	* Pattern work: 1 (improvements to the [InnerSource Activity Score](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/master/patterns/2-structured/repository-activity-score.md))
+	* Non-pattern work: 1
+* [New PRs created](https://github.com/InnerSourceCommons/InnerSourcePatterns/pulls?q=is%3Apr+created%3A2020-10-01..2020-10-31): 2
+
+## Plans of the Project
+
+*Describe the current plans of the project. Include goals the project is working towards as well as any announcements that should be published through the marketing group.*
+
+**Status: no changes/updates since last report**
+
+- Publish our [first official ebook](https://innersourcecommons.gitbook.io/innersource-patterns/v/book/) of the InnerSource Patterns. Once we do that, let’s announce that through our Marketing WG.
+- Process existing content from pull requests and Google group into our repository
+- Evaluate ideas to further facilitate collection of pattern content (e.g. through automation), channel ongoing discussions into pattern-work and attract more contributors, e.g. by lowering the barriers of entry for them.
+- Onboard further trusted committers
+- Possibly review the current list of trusted committers. Some of them don’t seem to be active anymore (likely they receive a lot of github/email spam from us today).
+
+## Last Committer Addition
+
+*When was the last committer added to the project? A healthy project tends to add new committers regularly. The report should indicate the most recent date on which a committer was added.*
+
+**Status: no changes/updates since last report**
+
+- 24th of April 2020: @lenucksi
+
+## Committer Diversity
+
+*Cover committer diversity in your project. A healthy project should survive the departure of any single contributor or employer of contributors. What are your steps to make sure that people from all regions on the globe can participate in your project without having to be awake at midnight their local time?*
+
+**Status: no changes/updates since last report**
+
+- Focus on asynchronous collaboration in the #innersource-patterns channel
+- Offering of office hours on APAC and EU/Americas friendly timeslots
+- Work towards automation of administration tasks, documentation of processes
+- Have TCs in multiple time zones
+
+## Legal Issues & Other Needs
+
+*Are there any project branding or naming issues, either in the project or externally? Any legal issues? Any infrastructure or strategic needs?*
+
+**Status: no changes/updates since last report**
+
+- None currently, book illustrations will trigger IP compliance requirements.
+- Suggestions welcome on how to attract more contributors.
+
+## Any issues for the Board to act on?
+
+- None

patterns/2-structured/innersource-portal.md

@@ -48,6 +48,7 @@ The InnerSource Portal has enabled InnerSource project owners to advertise their
 
 * A large financial services organization has used the creation of an InnerSource Portal to provide a mechanism of advertising and discovering InnerSource projects in existence across different business units
 * SAP promotes InnerSource projects in the InnerSource portal - projects can self-register using GitHub topics. The [Repository Activity Score](repository-activity-score.md) defines the default order of the InnerSource projects in the portal. Also see [Michael Graf & Harish B (SAP) at ISC.S11 - The Unexpected Path of Applying InnerSource Patterns](https://www.youtube.com/watch?v=6r9QOw9dcQo&list=PLCH-i0B0otNQZQt_QzGR9Il_kE4C6cQRy&index=6).
+* American Airlines promotes InnerSource projects via an [internal InnerSource Marketplace](https://tech.aa.com/2020-10-30-innersource/). Similarly to SAP, projects self-register by adding `innersource` as a GitHub topic. Projects are searchable and filterable by language, topics, number of open issues, etc.
 * The InnerSource Portal pattern has been proven to work extremely well with the associated InnerSource Gig Marketplace pattern in this context
 
 ## Status

patterns/2-structured/repository-activity-score.md

@@ -55,9 +55,10 @@ Manual adjustments according to soft KPIs (see [Forces](#forces)) can be made on
 ``` javascript
 // calculate a virtual InnerSource score from stars, watches, commits, and issues
 function calculateScore(repo) {
-    // weighting:
-    // forks and watches count most, then stars, add some little score for open issues, too
-    let iScore = 1 + repo["forks_count"] * 5 + repo["watchers_count"] + repo["stargazers_count"] / 3 + repo["open_issues_count"] / 5;
+    // initial score is 50 to give active repos with low GitHub KPIs (forks, watchers, stars) a better starting point
+    let iScore = 50;
+    // weighting: forks and watches count most, then stars, add some little score for open issues, too
+    iScore += repo["forks_count"] * 5 + repo["watchers_count"] + repo["stargazers_count"] / 3 + repo["open_issues_count"] / 5;
     let iDaysSinceLastUpdate = (new Date().getTime() - new Date(repo.updated_at).getTime()) / 1000 / 86400;
     // updated in last 3 months: adds a bonus multiplier between 0..1 to overall score (1 = updated today, 0 = updated more than 100 days ago)
     iScore = iScore * (1 + (100 - Math.min(iDaysSinceLastUpdate, 100)) / 100);
@@ -76,14 +77,16 @@ function calculateScore(repo) {
     iBoost *= (365 - Math.min(iDaysSinceCreation, 365)) / 365;
     // add boost to score
     iScore += iBoost;
+    // give projects with a meaningful description a static boost of 50
+    iScore += (repo["_InnerSourceMetadata"]["description"].length > 30 || repo["_InnerSourceMetadata"] && repo["_InnerSourceMetadata"]["motivation"].length > 30 ? 50 : 0);
     // give projects with contribution guidelines (CONTRIBUTING.md) file a static boost of 100
     iScore += (repo["_InnerSourceMetadata"] && repo["_InnerSourceMetadata"]["guidelines"] ? 100 : 0);
     // build in a logarithmic scale for very active projects (open ended but stabilizing around 5000)
     if (iScore > 3000) {
         iScore = 3000 + Math.log(iScore) * 100;
     }
-    // final score is a rounded value starting from 0
-    iScore = Math.round(iScore - 1);
+    // final score is a rounded value starting from 0 (subtract the initial value)
+    iScore = Math.round(iScore - 50);
     // add score to metadata on the fly
     repo._InnerSourceMetadata.score = iScore;
     return iScore;