Skip to content
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

Draft of contributor journey optimization pattern #787

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

spier
Copy link
Member

@spier spier commented Mar 9, 2025

Closes #786

See rendered preview here.

The pattern was mostly generated with this ChatGPT prompt.

Would be great to get feedback especially about "the concept" part of the prompt.

Describe the concept of "Contributor Journey Optimization" in the format of an InnerSource Pattern. Use the template for an InnerSource Pattern provided below.

# The concept:

With "Contributor Journey" we mean the progression of a user of an InnerSource project through various staging. Let's assume the following stages of a user:

- does not know the project
- knows the project
- uses the project
- makes non-code contributions to the project
- makes code contributions to the project
- becomes a trusted committer

These stages are meant as a progression from top to bottom.

With "Contributor Journey Optimization" we mean:

A method for evaluating a project's (potential) Contributor Journey, document impediments for a contributor to move from one stage to the next, and derive and prioritize concrete tasks to reduce the friction in the journey to a minimum. The goal is to maximize the value added by stakeholders to the project and taken by stakeholders from the project.

The idea is that this method can be applied as a workshop with project members (and maybe stakeholders), facilitated by a "coach", or in a self service manner by project maintainers.


# Template

## Title

Short Title Here

## Patlet

A two sentence description of the problem and solution.
The first sentence describes the problem you are looking to solve, while the second sentence describes the solution.
The first sentence of the Patlet should not mention anything about the solution.

Readers may quickly review dozens of these patlets to discover and browse the larger library of patterns.

## Problem

What is the problem - crisp definition of the problem.

Short description, usually not more than a couple sentences, that describes what the issues and challenges are.

Be careful not to morph into information found in other sections below.

## Story (optional)

Sometimes there is a story that helps people understand the pattern better.

## Context

Where does the problem exist?

What are the pre-conditions?

**Unchangeable** before the solution goes into place.

The content here is often tied to the applicability of the pattern for other readers: "Do I have this same particular situation?"

Use bullet points for this section, so that readers can quickly check if this applies to them.

## Forces

What makes the problem difficult?

What are the trade-offs?

These are constraints that **can be changed** at a cost.

The solution might change one or more of these forces in order to solve the problem, while also in-turn changing the context.

Use bullet points for this section.

## Sketch (optional)

visual illustration

## Solutions

Verified resolutions and possible resolutions to the problem.

## Resulting Context

What is the situation after the problem has been solved?

The original context is changed indirectly by way of the solution.

Often this section can include discussion of the next possible Patterns/problems introduced.

This section can be short in content - the solution may not introduce new problems or change much context.

## Rationale (optional)

Explains why this is the right solution; using totally different words WHY this solution balances these forces and this context to solve this problem.

Can expand on what-if's or theories.

## Known Instances (optional)

Where has this been seen before?

Helps to reinforce that this is a REAL pattern and that you match the context.

May mention:

* A particular business

* Anonymized instances ex: "3 companies have proven that this is a good solution" or "A large financial services org...".

## Status (optional until merging)

General pattern status is stored in GitHub's Label tagging - see any pull request.

Note that this GitHub label tagging becomes less visible once the pattern is finalized and merged, so having some information in this field is helpful.

You might store other related info here, such as review history: "Three of us reviewed this on 2/5/17 and it needs John's expertise before it can go further."

## Author(s) (optional)

Often, this is yourself.

If you need to, find someone in the InnerSource Commons to be the nominal author (As Told To).

Could also be no-one if you do not want to take on authorship (common with a donut looking for a solution).

## Acknowledgments (optional)

Include those who assisted in helping with this pattern - both for attribution and for possible future follow up.

Though optional, most patterns should list who helped in their creation.

## Alias (optional)

If this pattern is also known under a different name than what is listed unter **Title**, please list those alternative titles here.

e.g. if the pattern is named after the problem it solves, a helpful alias might be one that describes the solution that is applied.

@spier
Copy link
Member Author

spier commented Mar 9, 2025

@dellagustin-sap would love to get your feedback on this, as this is your idea after all :)

@spier spier added 1-initial Donuts, Early pattern ideas, ... (Please see our contribution handbook for details) 📖 Type - Content Work Working on contents is the main focus of this issue / PR labels Mar 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1-initial Donuts, Early pattern ideas, ... (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.

[Pattern Idea] Contributor Journey Optimization
1 participant