Skip to content

Commit 812d410

Browse files
authored
First AI prompt for pattern generation (#837)
* First prompt for AI agents * Link to the instructions from various places, so that potential pattern authors can find them. * Minor fix to the pattern template itself
1 parent 82e8b33 commit 812d410

File tree

4 files changed

+53
-8
lines changed

4 files changed

+53
-8
lines changed

.github/ISSUE_TEMPLATE/pattern-draft.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,20 @@ assignees: ''
77

88
---
99

10-
This is the most basic template for a new pattern.
11-
See our full pattern syntax [here](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md).
10+
If you don't know how to get started, try to [draft an InnerSource Pattern with AI](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-drafts-with-ai.md).
11+
Then you can paste the result into the issue below, do manual edits as you see fit and submit it.
12+
13+
Below you see a basic template for a new pattern.
14+
For the full details, see our [pattern template](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md).
1215

1316
## Title
1417

1518
Short Title Here
1619

1720
## Patlet / Summary
1821

19-
Concise 1-2 sentence description of the problem and solution.
22+
Concise 2 sentence description of the problem and solution.
23+
The 1st sentence describes the problem. The 2nd sentence describes the solution.
2024

2125
## Problem
2226

@@ -59,7 +63,7 @@ May mention:
5963
* A particular business
6064
* Anonymized instances ex: "3 companies have proven that this is a good solution" or "A large financial services org...".
6165

62-
## Status
66+
## Status
6367

6468
Initial
6569

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,11 @@ The pattern form is useful for describing proven patterns but it can also be use
146146

147147
## How to Contribute?
148148

149-
We welcome your contribution - be it small or huge! To learn more about how you can become a contributor, please see our [CONTRIBUTING.md](CONTRIBUTING.md) file.
149+
We welcome your contribution - be it small or huge!
150+
151+
If you are new here, and just want to play, you can quickly [draft an InnerSource Pattern with AI](meta/pattern-drafts-with-ai.md).
152+
153+
To learn more about how to contribute, refer to our [CONTRIBUTING.md](CONTRIBUTING.md) file.
150154

151155
## Licensing
152156

meta/pattern-drafts-with-ai.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Drafting InnerSource Pattern with AI
2+
3+
Our AI friends can help us to brainstorm and write new InnerSource patterns.
4+
Usual precaution should apply, as always with AI ;)
5+
6+
## How to use this
7+
8+
- Paste the below prompt into ChatGPT or your AI agent of choice.
9+
- Add a description of the **problem** you are looking to solve, as well as the intended **solution** (if you already have one in mind).
10+
- Let AI do its magic.
11+
- Then populate the missing sections and adapt the pattern manually as you see fit.
12+
- Finally, submit your work as a pull request to our repo.
13+
14+
You might also want to instruct the AI to return the answer as a markdown file, that you can more easily copy and paste into a GitHub Pull Request.
15+
16+
## Prompt
17+
18+
```
19+
I want to write a new InnerSource Pattern.
20+
21+
The pattern needs to follow this template:
22+
https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md
23+
24+
Further instructions:
25+
- Each headline in the template starts a new section, with a distinct semantic purpose.
26+
- Therefore the names of the headlines should be kept as they are. The headlines in the final pattern should appear in the same order as in the template.
27+
- The value of these sections should be "TBD": Known Instances, Author
28+
- The value of the Status section should be "Initial".
29+
- These sections should be removed: Acknowledgments
30+
- The section "Related Patterns" should contain markdown links to relevant patterns from https://patterns.innersourcecommons.org, including an explanation of how these patterns relate to this new pattern.
31+
- The word "(optional)" should be removed from the headlines.
32+
33+
This is the concept that I want to explain in the pattern:
34+
35+
<describe the problem and intended solution here in rough terms>
36+
```

meta/pattern-template.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ Short Title Here
44

55
## Patlet
66

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
7+
Concise 2 sentence description of the problem and solution.
8+
The 1st sentence describes the problem. The 2nd sentence describes the solution.
9+
Readers may quickly review dozens of these patlets (aka summaries) to discover and browse the larger library of patterns.
10+
From [http://wiki.c2.com/?PatLet](http://wiki.c2.com/?PatLet).
1011

1112
## Problem
1213

0 commit comments

Comments
 (0)