Merge branch 'main' into governance

Author: jeffabailey

CONTRIBUTING.md

@@ -23,7 +23,7 @@ This book uses the [Goal-Question-Metric] approach to documenting InnerSource me
 The full graph of relationships is visible in this [graph].
 
 Add in your scenarios by copying this [goal template], [question template], and/or [metric template], filling them out, and submitting them in pull request.
-After successful merge, a Trusted Committer will manually[^1] add those to the [graph].
+After successful merge, a [Trusted Committer](https://github.com/orgs/InnerSourceCommons/teams/ispo-working-group-trusted-committers) will manually[^1] add those to the [graph].
 If interested, feel free to [edit the MermaidJS source] of the graph on your own!
 
 By adding in your scenarios to the graph, you will be able to see how others approach and interact with them.
@@ -37,11 +37,11 @@ When using titles in Markdown, use # for main title, ## for the second header ti
 At that time this manual step will no longer be needed.
 
 [Goal-Question-Metric]: https://en.wikipedia.org/wiki/GQM
-[goals]: https://github.com/InnerSourceCommons/managing-inner-source-projects/tree/master/measuring/goals
-[questions]: https://github.com/InnerSourceCommons/managing-inner-source-projects/tree/master/measuring/questions
-[metrics]: https://github.com/InnerSourceCommons/managing-inner-source-projects/tree/master/measuring/metrics
-[goal template]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/goals/gqm_goal_template.md
-[question template]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/questions/gqm_question_template.md
-[metric template]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/metrics/gqm_metric_template.md
-[edit the MermaidJS source]: https://github.com/InnerSourceCommons/managing-inner-source-projects/edit/master/measuring/use_gqm.md
-[graph]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/use_gqm.md
+[goals]: https://github.com/InnerSourceCommons/managing-inner-source-projects/tree/main/measuring/goals
+[questions]: https://github.com/InnerSourceCommons/managing-inner-source-projects/tree/main/measuring/questions
+[metrics]: https://github.com/InnerSourceCommons/managing-inner-source-projects/tree/main/measuring/metrics
+[goal template]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/goals/gqm_goal_template.md
+[question template]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/questions/gqm_question_template.md
+[metric template]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/metrics/gqm_metric_template.md
+[edit the MermaidJS source]: https://github.com/InnerSourceCommons/managing-inner-source-projects/edit/main/measuring/use_gqm.md
+[graph]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/use_gqm.md

README.md

@@ -1,6 +1,6 @@
 # Managing InnerSource Projects book
 
-<img src="managing-innersource-projects-cover.jpg" title="Managing InnerSource Projects">
+![Managing InnerSource Projects](managing-innersource-projects-cover.jpg)
 
 This book is intended to bring, from a managerial perspective, the several aspects needed
 when introducing InnerSource methodologies into enterprises.
@@ -12,7 +12,7 @@ within this respect in a way that this is useful for third parties. For this, we
 actively looking for reviewers that can help in this process.
 For those that have already contributed to the book, thanks a lot!
 
-You can find more information about the process in the [contributing section](https://github.com/dicortazar/managing-inner-source-projects/blob/master/CONTRIBUTING.md).
+You can find more information about the process in the [contributing section](https://github.com/dicortazar/managing-inner-source-projects/blob/main/CONTRIBUTING.md).
 
 ## Who is fostering this initiative?
 
@@ -42,7 +42,6 @@ For further reading, we encourage you to participate in the [InnerSource Commons
 a non-profit foundation where dozens of companies are already sharing experiences and working to
 improve their craft of InnerSource.
 
-
 ## Acknowledgements
 
 Each chapter in the book is authored and reviewed by different people. That information can

SUMMARY.md

@@ -25,3 +25,9 @@
   * [References](measuring/references.md)
   * [Authors and Reviewers](measuring/authors.md)
 * [Governance](governance/governance.md)
+* [Tooling](tooling/innersource-tooling.md)
+  * [GitHub Strategy](tooling/github-strategy.md)
+  * [GitHub Configuration](tooling/github-configuration.md)
+  * [GitLab Strategy](tooling/gitlab-strategy.md)
+  * [GitLab Configuration](tooling/gitlab-configuration.md)
+  * [Authors and Reviewers](tooling/authors.md)

measuring/questions/who-uses.md

@@ -1,6 +1,6 @@
 [⬑ back to the overall graph](../use_gqm.md)
 
-# Question: Who uses the InnerSource project?
+# **Question:** Who uses the InnerSource project?
 
 Depending on the InnerSource project, usage of the project could look something like:
 

measuring/use_gqm.md

@@ -2,16 +2,16 @@
 
 *An overview of the Goals, Questions, and Metrics (GQM) catalog.*
 
-This page works better in GitHub; [click here](https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/use_gqm.md).
+This page works better in GitHub; [click here](https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/use_gqm.md).
 
 ```mermaid
 graph LR;
     subgraph GQM[Goals, Questions, Metrics]
-        find-projects[<a href='https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/goals/find-projects.md'>Find Projects</a>] --> who-uses[Who Uses]
-        reduce-duplication[<a href='https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/goals/reduce-duplication.md'>Reduce Duplication</a>] --> who-uses[<a href='https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/questions/who-uses.md'>Who Uses</a>]
-        who-uses --> usage-count[<a href='https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/metrics/usage-count.md'>Usage Count</a>]
+        find-projects[<a href='https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/goals/find-projects.md'>Find Projects</a>] --> who-uses[Who Uses]
+        reduce-duplication[<a href='https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/goals/reduce-duplication.md'>Reduce Duplication</a>] --> who-uses[<a href='https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/questions/who-uses.md'>Who Uses</a>]
+        who-uses --> usage-count[<a href='https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/metrics/usage-count.md'>Usage Count</a>]
         find-projects --> who-contributes
-        who-contributes[<a href='https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/questions/who-contributes.md'>Who Contributes</a>] --> code-contributions[<a href='https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/metrics/code-contributions.md'>Code Contributions</a>]
+        who-contributes[<a href='https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/questions/who-contributes.md'>Who Contributes</a>] --> code-contributions[<a href='https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/metrics/code-contributions.md'>Code Contributions</a>]
     end
     subgraph Legend
         direction TB
@@ -35,5 +35,4 @@ Add your goals, questions, and metrics into this graph!  It will help you to see
 You may get new ideas of what metrics answer the questions you have or what additional goals your questions can support.
 See [CONTRIBUTING.md#metrics].
 
-[CONTRIBUTING.md#metrics]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/CONTRIBUTING.md#metrics
-
+[CONTRIBUTING.md#metrics]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/CONTRIBUTING.md#metrics

package-lock.json

@@ -0,0 +1,47 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+# TypeScript
+*.map
+*.js
+
+# Project generated files
+*.pdf
+*.xlsx
+slides/*.md

scripts/gqm_gen/.gitignore

@@ -0,0 +1,12 @@
+# Goal, Question, Metrics Generator
+
+Creates a Mermaid diagram from Goal, Question, Metrics (GQM) Markdown files.
+
+## Usage
+
+Builds the mermaid diagram and outputs it to stdout.
+
+```bash
+npm install
+npm run --silent start
+```

scripts/gqm_gen/README.md

@@ -0,0 +1,5 @@
+import * as Commonmark from 'commonmark';
+export declare function getLinks(parsed: Commonmark.Node): {
+    url: string | null;
+    text: string | null | undefined;
+}[];

scripts/gqm_gen/index.d.ts

@@ -0,0 +1,41 @@
+import * as Commonmark from "commonmark";
+import test from "node:test";
+import assert from "node:assert";
+import { FileLink, Graph, LinkType } from "./types";
+import {
+  getLinks,
+  getFileLinks,
+  generateMermaidDiagram,
+  getGQMFileLinks,
+} from "./index";
+
+test("can get links", () => {
+  const node = new Commonmark.Node("paragraph");
+  const links = getLinks(node);
+  assert(links.length === 0);
+});
+
+test("can get links from file", () => {
+  const fileLinks: FileLink[] = getFileLinks(
+    LinkType.GOAL,
+    "../../measuring/goals/"
+  );
+  assert(fileLinks.length > 0);
+});
+
+test("can generate mermaid diagram", () => {
+  const graph: Graph = {
+    nodes: [],
+    edges: [],
+  };
+  const diagram = generateMermaidDiagram(graph);
+  assert(diagram.indexOf("graph TB") > 1);
+});
+
+test("can generate mermaid diagram from file", { only: true }, () => {
+  const graph = getGQMFileLinks();
+
+  const diagram = generateMermaidDiagram(graph);
+  console.log(diagram);
+  assert(diagram.indexOf("graph LR;") > 1);
+});