Skip to content

Commit 8f03be7

Browse files
author
Randy Pagels
committed
Refine descriptions and enhance clarity in InnerSource program documentation
1 parent 2495333 commit 8f03be7

File tree

6 files changed

+20
-9
lines changed

6 files changed

+20
-9
lines changed

learn-pr/github/manage-innersource-program-github/2-manage-innersource-program.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ uid: learn.github.manage-innersource-program-github.2-manage-innersource-program
33
title: How to manage a successful InnerSource program
44
metadata:
55
title: How to manage a successful InnerSource program
6-
description: Learn to manage a successful InnerSource program on GitHub through effective discoverability, guidance, and maintenance.
6+
description: Learn to manage a successful InnerSource program on GitHub through discoverability, guidance, repository setup, and collaboration best practices.
77
ms.date: 09/19/2024
88
author: a-a-ron
99
ms.author: aastewar

learn-pr/github/manage-innersource-program-github/3-innersource-fundamentals.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ uid: learn.github.manage-innersource-program-github.3-innersource-fundamentals
33
title: Exercise - InnerSource fundamentals
44
metadata:
55
title: Exercise - InnerSource fundamentals
6-
description: Learn to manage a successful InnerSource program on GitHub through effective discoverability, guidance, and maintenance.
6+
description: Use checklists to evaluate your InnerSource readiness and improve your GitHub repositories through practical repository and team-based actions.
77
ms.date: 09/19/2024
88
author: a-a-ron
99
ms.author: aastewar

learn-pr/github/manage-innersource-program-github/5-summary.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ uid: learn.github.manage-innersource-program-github.5-summary
33
title: Summary
44
metadata:
55
title: Summary
6-
description: Review what you learned about InnerSource programs.
6+
description: Review key practices for managing an InnerSource program using GitHub, including transparency, repository management, and collaboration.
77
ms.date: 09/19/2024
88
author: a-a-ron
99
ms.author: aastewar

learn-pr/github/manage-innersource-program-github/includes/2-manage-innersource-program.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,14 @@ Anyone can freely use, modify, and share open-source software. Using open-source
1010

1111
An InnerSource program can offer numerous benefits beyond what traditional closed-source models provide.
1212

13-
First, they *encourage transparency*. Access to the source code of other company projects can help developers be more productive when working on their own projects. They can see how different teams solve problems similar to the ones they're facing, and often find code and other assets that they can reuse. Access to team issues, pull requests, and project plans also provide better data for them to understand the velocity and direction of the project.
13+
First, they *support internal visibility*. Access to the source code of other company projects can help developers be more productive when working on their own projects. They can see how different teams solve problems similar to the ones they're facing, and often find code and other assets that they can reuse. Access to team issues, pull requests, and project plans also provide better data for them to understand the velocity and direction of the project.
1414

15-
Next, they *reduce friction*. Let's say that a consumer team is dependent on a bug fix or new feature for a project owned by a different team. IN an InnerSource program, they have a channel through which they can propose the changes they need. And if those changes can't be merged in for any reason, the consumer team has the option of forking the project to meet their needs.
15+
Next, they *reduce friction*. Let's say that a consumer team is dependent on a bug fix or new feature for a project owned by a different team. In an InnerSource program, they have a channel through which they can propose the changes they need. And if those changes can't be merged in for any reason, the consumer team has the option of forking the project to meet their needs.
1616

1717
Finally, they *standardize practices*. A common challenge development organizations face is that different teams often diverge in the ways they operate. Building an InnerSource program is a great opportunity to adopt standard conventions that can be used across every development team, even if they don't follow identical practices. For example, two teams might prefer different processes for accepting contributions. Having them standardize on the way they communicate their different processes makes it much easier for anyone to contribute to either.
1818

19+
**Tip:** Consider using GitHub Discussions and GitHub Projects to further support InnerSource collaboration across teams.
20+
1921
These examples are just a few of the benefits enjoyed by InnerSource programs. To learn more, see [An introduction to InnerSource](https://resources.github.com/whitepapers/introduction-to-innersource/?azure-portal=true).
2022

2123
## Set up an InnerSource program on GitHub

learn-pr/github/manage-innersource-program-github/includes/3-innersource-fundamentals.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,14 @@ The following guide provides you with a getting started and expanded checklist o
77
- Project
88
- Developers
99

10-
Using the provided checklists, pick one of these categories and compare the list of items to one of your existing repositories. If you're focusing on the repository itself, what files do you need to add or remove to add clarity around its purpose? How do you contribute to the repository or open up issues?
10+
Using the provided checklists, choose one category and compare it to one of your current repositories. For example, if you're focusing on the repository itself, which files should be added or removed to clarify its purpose and contribution process?**
11+
12+
**Example checklist – Repository:**
13+
- [ ] Add or update `README.md`
14+
- [ ] Include `LICENSE`
15+
- [ ] Provide a clear contribution guide (`CONTRIBUTING.md`)
16+
- [ ] Set repository visibility (public/internal/private)
17+
- [ ] Include issue and pull request templates
1118

1219
After reading through the guide and identifying ways to improve your own GitHub repositories, return here for:
1320

learn-pr/github/manage-innersource-program-github/includes/5-summary.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
In this module, you learned how to manage a successful InnerSource program on GitHub through effective discoverability, guidance, and maintenance.
1+
In this module, you explored how to build and manage a successful InnerSource program on GitHub through effective discoverability, guidance, and maintenance.
22

3-
You learned about:
3+
This module covered:
44

55
- Contrasting user owned projects versus organization owned projects.
66
- Making recommendations about the number of GitHub organizations you should have.
77
- Creating discoverable repositories.
88
- Creating robust repository READMEs.
9-
- Using templates for issue requests and pull requests.
9+
- Using templates for issues and pull requests.
1010
- Building transparency into repositories.
1111
- Measuring the success of InnerSource within your organization.
1212
- Distributing your InnerSource toolkit.
1313

14+
Apply these practices to your team projects to strengthen your InnerSource approach.
15+
1416
Now that you have an InnerSource program together, learn to [Create an open-source program by using GitHub best practices](/training/modules/create-open-source-program-github/?azure-portal=true).
1517

1618
## Learn more

0 commit comments

Comments
 (0)