Skip to content

Commit

Permalink
Merge branch 'main' into ki-innersource-license-gpsl
Browse files Browse the repository at this point in the history
  • Loading branch information
spier authored Feb 27, 2024
2 parents 68e2c10 + 2fb2a04 commit 962e57a
Show file tree
Hide file tree
Showing 120 changed files with 7,559 additions and 960 deletions.
4 changes: 4 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,7 @@
/book/zh/ @WillemJiang
/translation/pt/ @jrcosta @zilio
/book/pt/ @jrcosta @zilio
/pattern-categorization/pt-br/ @jrcosta @zilio
/translation/gl/ @psanxiao
/book/gl/ @psanxiao
/pattern-categorization/gl/ @psanxiao
8 changes: 4 additions & 4 deletions .github/workflows/book.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
name: Gitbook Generation

on:
workflow_dispatch:
push:
branches:
- main
pull_request:
pull_request_target:
branches:
- main

Expand All @@ -14,12 +15,10 @@ jobs:

strategy:
matrix:
language: [en, ja, zh, pt-br]
language: [en, ja, zh, pt-br, gl]

steps:
- uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }}

- uses: ruby/setup-ruby@v1
with:
Expand All @@ -37,3 +36,4 @@ jobs:
uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: Writing updated toc.md for the ${{ matrix.language }} book
branch: ${{ github.head_ref }}
16 changes: 12 additions & 4 deletions .github/workflows/generate-mindmap.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: Generate Mindmap

on:
workflow_dispatch:
push:
branches:
- "main"
Expand All @@ -9,6 +10,8 @@ on:
- ".github/workflows/generate-mindmap.yml"
- "pattern-categorization/innersource-program-mind-map.md"
- "pattern-categorization/package.json"
- "pattern-categorization/gl/*"
- "pattern-categorization/pt-br/*"

defaults:
run:
Expand All @@ -17,6 +20,11 @@ defaults:
jobs:
generate-mindmap:
runs-on: ubuntu-latest

strategy:
matrix:
folder: [".", "./gl", "./pt-br"]

steps:
- uses: actions/checkout@v3
- name: Use Node.js
Expand All @@ -28,18 +36,18 @@ jobs:
- name: Install Node.js dependencies
run: npm install
- name: Run Markmap
run: npx markmap --no-toolbar innersource-program-mind-map.md -o innersource-program-mind-map.html
run: npx markmap --no-toolbar ${{ matrix.folder }}/innersource-program-mind-map.md -o ${{ matrix.folder }}/innersource-program-mind-map.html
- name: Screenshot Markmap Website
id: screenshot-generator
uses: swinton/screenshot-website@v1.x
with:
source: pattern-categorization/innersource-program-mind-map.html
source: pattern-categorization/${{ matrix.folder }}/innersource-program-mind-map.html #strange syntax here. seems to not respect the working-directory default either
destination: innersource-program-mind-map.png
full-page: false
- name: Copy Screenshot
run: cp ${{ steps.screenshot-generator.outputs.path }} .
run: cp ${{ steps.screenshot-generator.outputs.path }} ${{ matrix.folder }}
- name: Reduce Screenshot Size (PNG)
run: npx optipng innersource-program-mind-map.png
run: npx optipng ${{ matrix.folder }}/innersource-program-mind-map.png
- name: Commit Changes
uses: stefanzweifel/git-auto-commit-action@v4
with:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/i18n-consistency-checker.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
language: [ja, zh]
language: [ja, zh, pt-br, gl]
steps:
- uses: actions/checkout@v3
with:
Expand All @@ -24,7 +24,7 @@ jobs:
id: check-consistency
run: |
# Declare the flags
declare -A flags=( ["ja"]=":jp: Japanese" ["zh"]=":cn: Chinese")
declare -A flags=( ["ja"]=":jp: Japanese" ["zh"]=":cn: Chinese" ["pt-br"]=":brazil: Brazilian Portuguese" ["gl"]="Galician")
issue_title="${flags['${{matrix.language}}']}: Content Consistency Issue"
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/lint-patterns.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# from: https://github.com/marketplace/actions/markdown-linting-action
# To test this locally, switch to the root of the repo and run:
# markdownlint -r config/lint/pattern-template.js -c config/lint/pattern-template.yml patterns/2-structured/*.md patterns/2-structured/project-setup/*.md patterns/3-validated/*.md
# markdownlint -r config/lint/pattern-template.js -c config/lint/pattern-template.yml patterns/2-structured/*.md patterns/3-validated/*.md
name: Pattern Syntax Validation

on:
Expand All @@ -12,7 +12,6 @@ on:
- ".github/workflows/lint-patterns.yml"
- ".github/lint-pattern-syntax/*"
- "patterns/2-structured/*.md"
- "patterns/2-structured/project-setup/*.md"
- "patterns/3-validated/*.md"

jobs:
Expand All @@ -27,4 +26,4 @@ jobs:
with:
rules: './.github/lint-pattern-syntax/pattern-template.js'
config: './.github/lint-pattern-syntax/pattern-template.yml'
args: 'patterns/2-structured/*.md patterns/2-structured/project-setup/*.md patterns/3-validated/*.md'
args: 'patterns/2-structured/*.md patterns/3-validated/*.md'
2 changes: 1 addition & 1 deletion .github/workflows/pattern-metrics.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ jobs:
# Store CODEOWNERS_FILTERto GitHub Action environment (not permanent)
echo "CODEOWNERS_FILTER=$CODEOWNERS_FILTER" >> "$GITHUB_ENV"
- name: Run issue-metrics tool
- name: Run issue-metrics tool for issues
uses: github/issue-metrics@v2
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# InnerSource Patterns

<a href="https://patterns.innersourcecommons.org">
<img align="right" src="book/en/innersource-patterns-book-cover.jpg" title="The InnerSource Patterns book" width="30%"></a>
<img align="right" src="book/en/innersource-patterns-book-cover.jpg" title="The InnerSource Patterns book" alt="The InnerSource Patterns book" width="30%"></a>

This repository contains the InnerSource Patterns collected by the [InnerSource Commons][isc-website]. These patterns are InnerSource best practices codified in a specific format to make it easy to understand, evaluate, and reuse them.

Expand Down Expand Up @@ -47,9 +47,9 @@ Our mission
* [Review Committee](patterns/2-structured/review-committee.md) - *The InnerSource working model is a radical departure from more traditional approaches, for developers and managers alike. By establishing a review committee as an interface between the InnerSource initiative and all senior managers of business units participating in it, the latter are more likely to familiarise themselves with the initiative and support it, as it affords them a certain level of oversight and control without fostering micromanagement.*
* [Service vs. Library](patterns/2-structured/service-vs-library.md) - *Teams in a DevOps environment may be reluctant to work across team boundaries on common code bases due to ambiguity over who will be responsible for responding to service downtime. The solution is to realize that often it's possible to either deploy the same service in independent environments with separate escalation chains in the event of service downtime or factor a lot of shared code out into one library and collaborate on that.*
* [Trusted Committer](patterns/2-structured/trusted-committer.md) - *Many InnerSource projects will find themselves in a situation where they consistently receive feedback, features, and bug-fixes from contributors. In these situations project maintainers seek ways to recognize and reward the work of the contributor above and beyond single contributions.*
* [Standard Base Documentation](patterns/2-structured/project-setup/base-documentation.md) - *New contributors to an InnerSource project have a hard time figuring out who maintains the project, what to work on, and how to contribute. Providing documentation in standard files like README.md/CONTRIBUTING.md enables a self service process for new contributors, so that they can find the answers to the most common questions on their own.*
* [Issue Tracker Use Cases](patterns/2-structured/project-setup/issue-tracker.md) - *The InnerSource host team fails to make not only plans and progress but also context for changes transparent. This is solved by increasing the use cases for the project issue tracker to also serve brainstorming, implementation discussion, and feature design.*
* [Communication Tooling](patterns/2-structured/project-setup/communication-tooling.md) - *The users of an InnerSource project have trouble getting help and getting in touch with the host team. By consistently using asynchronous communication tooling, the project makes discussions visible, archived and searchable, leading to an improved level of support for users.*
* [Standard Base Documentation](patterns/2-structured/base-documentation.md) - *New contributors to an InnerSource project have a hard time figuring out who maintains the project, what to work on, and how to contribute. Providing documentation in standard files like README.md/CONTRIBUTING.md enables a self service process for new contributors, so that they can find the answers to the most common questions on their own.*
* [Issue Tracker Use Cases](patterns/2-structured/issue-tracker.md) - *The InnerSource host team fails to make not only plans and progress but also context for changes transparent. This is solved by increasing the use cases for the project issue tracker to also serve brainstorming, implementation discussion, and feature design.*
* [Communication Tooling](patterns/2-structured/communication-tooling.md) - *The users of an InnerSource project have trouble getting help and getting in touch with the host team. By consistently using asynchronous communication tooling, the project makes discussions visible, archived and searchable, leading to an improved level of support for users.*
* [Cross-Team Project Valuation](patterns/2-structured/crossteam-project-valuation.md) - *It's hard to sell the value of cross-team InnerSource projects that don't provide a direct impact on company revenue. Here's a data-driven way to represent your project that both articulates its value and amplifies it.*
* [Transparent Cross-Team Decision Making using RFCs](patterns/2-structured/transparent-cross-team-decision-making-using-rfcs.md) - *InnerSource projects that want to achieve high participation rates and make the best possible decisions for everybody involved need to find ways to create participatory systems throughout the full software lifecycle. Publishing internal Requests for Comments (RFCs) documents allows for discussions early on in the design process, and increases the chances to build solutions with a high degree of commitment from all involved parties.*
* [Start as an Experiment](patterns/2-structured/start-as-experiment.md) - *Start your InnerSource initiative as a time limited experiment to make it easier for managers unfamiliar with InnerSource to endorse and support the initiative.*
Expand Down Expand Up @@ -108,6 +108,7 @@ This is why we keep these patterns at the bottom of the list.
* [Bad Weather For Liftoff](patterns/1-initial/bad-weather-for-liftoff.md)
* [Incentive mechanisms to foster voluntary contribution](patterns/1-initial/incentive-mechanisms-for-voluntary-contribution.md)
* [Duplicated Projects](patterns/1-initial/duplicated-projects.md)
* [Sustainable InnerSource Program](patterns/1-initial/sustainable-innersource-program.md)

## What are InnerSource Patterns?

Expand Down
1 change: 1 addition & 0 deletions TRUSTED-COMMITTERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ While they don't take all responsibilities of a Trusted Committer (yet), they do
* Japanese - [@yuhattor](https://github.com/yuhattor)
* Chinese - [@WillemJiang](https://github.com/WillemJiang)
* Brazilian Portuguese - [@jrcosta](https://github.com/jrcosta), [@zilio](https://github.com/zilio)
* Galician - [@psanxiao](https://github.com/psanxiao)

## Hall of Fame (aka Alumni)

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/gl/README-for-users.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/gl/bios-principles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/gl/communication-tooling.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/gl/core-team.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/gl/repository_activity_score.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/gl/review-committee-sketch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion assets/img/standard-base-documentation/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Credits

The current illustration is a digital remake of this [original visual](/patterns/2-structured/project-setup/assets/base_docs_drawing.png).
The current illustration is a digital remake of this [original visual](./base_docs_drawing.png).
If you want to edit this illustration, please request access to this [source document](https://docs.google.com/presentation/d/11JOByEO9QXlRLXX5BIv9rjUzPzCKErZzknD1OLcprQQ/edit?usp=sharing).

The humans in the illustration are [bro](https://storyset.com/illustration/coding/bro) and [pana](https://storyset.com/illustration/high-five/pana) from Storyset.
Expand Down
Loading

0 comments on commit 962e57a

Please sign in to comment.