Skip to content

Commit da45146

Browse files
committed
Improve the AI instructions. Link to the instructions from various places, so that potential pattern authors can find them.
1 parent bd33e5c commit da45146

File tree

4 files changed

+29
-19
lines changed

4 files changed

+29
-19
lines changed

.github/ISSUE_TEMPLATE/pattern-draft.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ assignees: ''
1010
This is the most basic template for a new pattern.
1111
See our full pattern syntax [here](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md).
1212

13+
If you don't know how to get started, try to [draft an InnerSource Pattern with AI](meta/pattern-drafts-with-ai.md).
14+
1315
## Title
1416

1517
Short Title Here

README.md

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

145145
## How to Contribute?
146146

147-
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.
147+
We welcome your contribution - be it small or huge!
148+
149+
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).
150+
151+
To learn more about how to contribute, refer to our [CONTRIBUTING.md](CONTRIBUTING.md) file.
148152

149153
## Licensing
150154

meta/pattern-drafts-with-ai.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
1-
# Creating InnerSource Pattern Drafts with AI
1+
# Drafting InnerSource Pattern with AI
22

33
Our AI friends can help us to brainstorm and write new InnerSource patterns.
44
Usual precaution should apply, as always with AI ;)
55

66
Below we share various prompts and instructions for different API tools.
77

8-
## ChatGPT
8+
## How to use this
99

10-
Paste this prompt into ChatGPT, and add a description of the problem you are looking to solve, as well as the intended solution.
11-
Then populate the missing sections manually as you see fit.
10+
How to use this prompt:
1211

13-
You might also want to add an instruction to offer the answer directly as a markdown file.
12+
- Paste the below prompt into ChatGPT or your AI agent of choice.
13+
- Add a description of the **problem** you are looking to solve, as well as the intended **solution** (if you already have one in mind).
14+
- Let AI do its magic
15+
- Then populate the missing sections manually as you see fit.
16+
17+
You might also want to add an instruction to return the answer directly as a markdown file, that you can more easily copy and paste into a GitHub Pull Request.
18+
19+
## Prompt
1420

1521
```
1622
I want to write a new InnerSource Pattern.
@@ -19,18 +25,15 @@ The pattern needs to follow this template:
1925
https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md
2026
2127
Further instructions:
22-
- The headlines in the resulting pattern should be exactly the ones used in the template, and in the same order as in the template.
23-
- Leave the following sections empty: Known Instances, Status, Author, Related Patterns
28+
- Each headline in the template starts a new section, with a distinct semantic purpose.
29+
- 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.
30+
- These sections should contain the value "TBD": Known Instances, Author
31+
- These sections should be removed: Acknowledgments
32+
- 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.
33+
- The value of the Status section should be "Initial"
34+
- The word "(optional)" should be removed from the headlines.
2435
2536
This is the concept that I want to explain in the pattern:
2637
2738
<describe the problem and intended solution here in rough terms>
2839
```
29-
30-
## Cursor
31-
32-
TBD
33-
34-
## GitHub Copilot
35-
36-
TBD

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)