|
| 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 | +``` |
0 commit comments