Skip to content

Commit cd8d9ce

Browse files
committed
Reformatting of 'Improve Findability'. fix InnerSource spelling.
1 parent 44426ad commit cd8d9ce

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The below lists all known patterns. They are grouped into three [maturity levels
5353
### Maturity Level 1: Initial
5454

5555
* [Modular Code](patterns/1-initial/modular-code.md) - *Management does not want to spend the extra resources needed to develop modular components and make them available in a visible repository for others to use.*
56-
* [Improve Findability](patterns/1-initial/improve-findability.md) - *People can't find the internally developed solutions that they need due to poor naming conventions. This causes frustration in finding inner source solutions and a reduction in code reuse.*
56+
* [Improve Findability](patterns/1-initial/improve-findability.md) - *People can't find the internally developed solutions that they need due to poor naming conventions. This causes frustration in finding InnerSource solutions and a reduction in code reuse.*
5757
* [Overcoming Project Management Time Pressures](patterns/1-initial/overcoming-project-management-time-pressures.md) - *Project management believes timeline pressure and commitments on feature content does not allow for developers to spend the time needed to develop shareable code and provide support.*
5858
* [Introducing Metrics in InnerSource](patterns/1-initial/introducing-metrics-in-innersource.md) - *Involve all stakeholders in designing and interpreting metrics to measure the current status in terms of health and performance of the InnerSource initiative.*
5959
* [Shared Code Repo Different from Build Repo](patterns/1-initial/shared-code-repo-different-from-build-repo.md) - *Deal with the overhead of having shared code in a separate repository that isn't the same as the project-specific one that is tied to production builds.*

patterns/1-initial/improve-findability.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,13 @@
22

33
Improve Findability
44

5-
## Also Known As
6-
7-
- Badly Named Piles
8-
- Poor Naming Conventions
9-
105
## Patlet
116

12-
TBD
7+
People can't find the internally developed solutions that they need due to poor naming conventions. This causes frustration in finding InnerSource solutions and a reduction in code reuse.
138

149
## Problem
1510

16-
People can't find the internally developed solutions that they need due to poor naming conventions.
11+
People can't find the internally developed solutions that they need due to poor naming conventions. This causes frustration in finding InnerSource solutions and a reduction in code reuse.
1712

1813
## Context
1914

@@ -36,14 +31,14 @@ To help improve findability for inner source projects:
3631
- Include keywords in project descriptions.
3732
- Apply tagging to repositories (validated).
3833
- Use labels where possible.
39-
- If possible, pull repository names, descriptions, and README.md files into the search engine (not the code itself).
34+
- If possible, pull repository names, descriptions, and `README.md` files into the search engine (not the code itself).
4035
- Instate a concierge service (guide) to help product people find stuff. (This approach might not scale, but could be helpful at the beginning of a program.)
4136

4237
<img alt="Poor naming conventions" src="/assets/img/poornamingconventions.jpg" width="70%">
4338

4439
## Known Instances
4540

46-
None known as of yet---this is a pattern idea until it is proven.
41+
None known as of yet - this is a pattern idea until it is proven.
4742

4843
## Desired Resulting Context
4944

@@ -67,3 +62,8 @@ None known as of yet---this is a pattern idea until it is proven.
6762
- Erin Bank (CA Technologies)
6863
- Padma Sudarsan (Nokia)
6964
- Tim Yao (Nokia)
65+
66+
## Also Known As
67+
68+
- Badly Named Piles
69+
- Poor Naming Conventions

0 commit comments

Comments
 (0)