Skip to content

Commit 0c5da7f

Browse files
authored
Put each sentence on its own line (#344)
Put each sentence on its own line. Renders the same while being easier to work with in edit mode.
1 parent d96fb54 commit 0c5da7f

File tree

1 file changed

+31
-11
lines changed

1 file changed

+31
-11
lines changed

meta/pattern-template.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,33 @@ Short Title Here
44

55
## Patlet
66

7-
Concise 1-2 sentence description of the problem and solution. Readers may quickly review dozens of these patlets to discover and browse the larger library of patterns. From http://wiki.c2.com/?PatLet
7+
Concise 1-2 sentence description of the problem and solution.
8+
Readers may quickly review dozens of these patlets to discover and browse the larger library of patterns.
9+
From http://wiki.c2.com/?PatLet
810

911
## Problem
1012

11-
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.
13+
What is the problem - crisp definition of the problem.
14+
Short description, usually not more than a couple sentences, that describes what the issues and challenges are.
15+
Be careful not to morph into information found in other sections below.
1216

1317
## Story (optional)
1418

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

1721
## Context
1822

19-
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?"
23+
Where does the problem exist?
24+
What are the pre-conditions?
25+
**Unchangeable** before the solution goes into place.
26+
The content here is often tied to the applicability of the pattern for other readers: "Do I have this same particular situation?"
2027

2128
## Forces
2229

23-
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.
30+
What makes the problem difficult?
31+
What are the trade-offs?
32+
These are constraints that **can be changed** at a cost.
33+
The solution might change one or more of these forces in order to solve the problem, while also in-turn changing the context.
2434

2535
## Sketch (optional)
2636

@@ -32,15 +42,20 @@ Verified resolutions and possible resolutions to the problem.
3242

3343
## Resulting Context
3444

35-
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.
45+
What is the situation after the problem has been solved?
46+
The original context is changed indirectly by way of the solution.
47+
Often this section can include discussion of the next possible Patterns/problems introduced.
48+
This section can be short in content - the solution may not introduce new problems or change much context.
3649

3750
## Rationale (optional)
3851

39-
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.
52+
Explains why this is the right solution; using totally different words WHY this solution balances these forces and this context to solve this problem.
53+
Can expand on what-if's or theories.
4054

4155
## Known Instances (optional)
4256

43-
Where has this been seen before? Helps to reinforce that this is a REAL pattern and that you match the context.
57+
Where has this been seen before?
58+
Helps to reinforce that this is a REAL pattern and that you match the context.
4459

4560
May mention:
4661

@@ -49,18 +64,23 @@ May mention:
4964

5065
## Status (optional until merging)
5166

52-
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.
67+
General pattern status is stored in GitHub's Label tagging - see any pull request.
68+
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.
5369

5470
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."
5571

5672
## Author(s) (optional)
5773

58-
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)
74+
Often, this is yourself.
75+
If you need to, find someone in the InnerSource Commons to be the nominal author (As Told To).
76+
Could also be no-one if you do not want to take on authorship (common with a donut looking for a solution).
5977

6078
## Acknowledgements (optional)
6179

62-
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.
80+
Include those who assisted in helping with this pattern - both for attribution and for possible future follow up.
81+
Though optional, most patterns should list who helped in their creation.
6382

6483
## Alias (optional)
6584

66-
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.
85+
If this pattern is also known under a different name than what is listed unter **Title**, please list those alternative titles here.
86+
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.

0 commit comments

Comments
 (0)