From bd33e5c1dfbfa01109c24d617d274ec8294c5857 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Wed, 3 Sep 2025 00:37:57 +0200 Subject: [PATCH 1/7] First draft of a prompt for ChatGPT --- meta/pattern-drafts-with-ai.md | 36 ++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 meta/pattern-drafts-with-ai.md diff --git a/meta/pattern-drafts-with-ai.md b/meta/pattern-drafts-with-ai.md new file mode 100644 index 000000000..edf716d5f --- /dev/null +++ b/meta/pattern-drafts-with-ai.md @@ -0,0 +1,36 @@ +# Creating InnerSource Pattern Drafts with AI + +Our AI friends can help us to brainstorm and write new InnerSource patterns. +Usual precaution should apply, as always with AI ;) + +Below we share various prompts and instructions for different API tools. + +## ChatGPT + +Paste this prompt into ChatGPT, and add a description of the problem you are looking to solve, as well as the intended solution. +Then populate the missing sections manually as you see fit. + +You might also want to add an instruction to offer the answer directly as a markdown file. + +``` +I want to write a new InnerSource Pattern. + +The pattern needs to follow this template: +https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md + +Further instructions: +- The headlines in the resulting pattern should be exactly the ones used in the template, and in the same order as in the template. +- Leave the following sections empty: Known Instances, Status, Author, Related Patterns + +This is the concept that I want to explain in the pattern: + + +``` + +## Cursor + +TBD + +## GitHub Copilot + +TBD From da45146a7430424e17e0adb0af543f5021439279 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Mon, 6 Oct 2025 21:53:32 +0200 Subject: [PATCH 2/7] Improve the AI instructions. Link to the instructions from various places, so that potential pattern authors can find them. --- .github/ISSUE_TEMPLATE/pattern-draft.md | 2 ++ README.md | 6 ++++- meta/pattern-drafts-with-ai.md | 33 ++++++++++++++----------- meta/pattern-template.md | 7 +++--- 4 files changed, 29 insertions(+), 19 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/pattern-draft.md b/.github/ISSUE_TEMPLATE/pattern-draft.md index 502501ef9..9f723fe1c 100644 --- a/.github/ISSUE_TEMPLATE/pattern-draft.md +++ b/.github/ISSUE_TEMPLATE/pattern-draft.md @@ -10,6 +10,8 @@ assignees: '' This is the most basic template for a new pattern. See our full pattern syntax [here](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md). +If you don't know how to get started, try to [draft an InnerSource Pattern with AI](meta/pattern-drafts-with-ai.md). + ## Title Short Title Here diff --git a/README.md b/README.md index 38ccd8e7c..9a1985ad2 100644 --- a/README.md +++ b/README.md @@ -144,7 +144,11 @@ The pattern form is useful for describing proven patterns but it can also be use ## How to Contribute? -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. +We welcome your contribution - be it small or huge! + +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). + +To learn more about how to contribute, refer to our [CONTRIBUTING.md](CONTRIBUTING.md) file. ## Licensing diff --git a/meta/pattern-drafts-with-ai.md b/meta/pattern-drafts-with-ai.md index edf716d5f..7688e5510 100644 --- a/meta/pattern-drafts-with-ai.md +++ b/meta/pattern-drafts-with-ai.md @@ -1,16 +1,22 @@ -# Creating InnerSource Pattern Drafts with AI +# Drafting InnerSource Pattern with AI Our AI friends can help us to brainstorm and write new InnerSource patterns. Usual precaution should apply, as always with AI ;) Below we share various prompts and instructions for different API tools. -## ChatGPT +## How to use this -Paste this prompt into ChatGPT, and add a description of the problem you are looking to solve, as well as the intended solution. -Then populate the missing sections manually as you see fit. +How to use this prompt: -You might also want to add an instruction to offer the answer directly as a markdown file. +- Paste the below prompt into ChatGPT or your AI agent of choice. +- Add a description of the **problem** you are looking to solve, as well as the intended **solution** (if you already have one in mind). +- Let AI do its magic +- Then populate the missing sections manually as you see fit. + +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. + +## Prompt ``` I want to write a new InnerSource Pattern. @@ -19,18 +25,15 @@ The pattern needs to follow this template: https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md Further instructions: -- The headlines in the resulting pattern should be exactly the ones used in the template, and in the same order as in the template. -- Leave the following sections empty: Known Instances, Status, Author, Related Patterns +- Each headline in the template starts a new section, with a distinct semantic purpose. +- 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. +- These sections should contain the value "TBD": Known Instances, Author +- These sections should be removed: Acknowledgments +- 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. +- The value of the Status section should be "Initial" +- The word "(optional)" should be removed from the headlines. This is the concept that I want to explain in the pattern: ``` - -## Cursor - -TBD - -## GitHub Copilot - -TBD diff --git a/meta/pattern-template.md b/meta/pattern-template.md index 693165c94..903fa7224 100644 --- a/meta/pattern-template.md +++ b/meta/pattern-template.md @@ -4,9 +4,10 @@ Short Title Here ## Patlet -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 +Concise 2 sentence description of the problem and solution. +The 1st sentence describes the problem. The 2nd sentence describes the solution. +Readers may quickly review dozens of these patlets (aka summaries) to discover and browse the larger library of patterns. +From [http://wiki.c2.com/?PatLet](http://wiki.c2.com/?PatLet). ## Problem From 2a6ad8be5afddfc03c939de3aee3e4f68c900810 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Mon, 6 Oct 2025 21:57:00 +0200 Subject: [PATCH 3/7] Rewording --- .github/ISSUE_TEMPLATE/pattern-draft.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/pattern-draft.md b/.github/ISSUE_TEMPLATE/pattern-draft.md index 9f723fe1c..44fd826ba 100644 --- a/.github/ISSUE_TEMPLATE/pattern-draft.md +++ b/.github/ISSUE_TEMPLATE/pattern-draft.md @@ -8,7 +8,7 @@ assignees: '' --- This is the most basic template for a new pattern. -See our full pattern syntax [here](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md). +Here you find the full [pattern template](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md). If you don't know how to get started, try to [draft an InnerSource Pattern with AI](meta/pattern-drafts-with-ai.md). From a55090f25d0efcee21a6cc4bc41327ee40063da0 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Mon, 6 Oct 2025 22:55:40 +0200 Subject: [PATCH 4/7] Fixes --- .github/ISSUE_TEMPLATE/pattern-draft.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/pattern-draft.md b/.github/ISSUE_TEMPLATE/pattern-draft.md index 44fd826ba..3ba1451b9 100644 --- a/.github/ISSUE_TEMPLATE/pattern-draft.md +++ b/.github/ISSUE_TEMPLATE/pattern-draft.md @@ -7,10 +7,11 @@ assignees: '' --- -This is the most basic template for a new pattern. -Here you find the full [pattern template](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md). - If you don't know how to get started, try to [draft an InnerSource Pattern with AI](meta/pattern-drafts-with-ai.md). +Then you can paste the result into the issue below, do manual edits as you see fit and submit it. + +Below you see a basic template for a new pattern. +For the full details, see our [pattern template](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md). ## Title @@ -61,7 +62,7 @@ May mention: * A particular business * Anonymized instances ex: "3 companies have proven that this is a good solution" or "A large financial services org...". -## Status +## Status Initial From d73516fb28395fd792e1f6a5d400989e089fdbda Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Mon, 6 Oct 2025 23:06:43 +0200 Subject: [PATCH 5/7] Fixes --- .github/ISSUE_TEMPLATE/pattern-draft.md | 2 +- meta/pattern-drafts-with-ai.md | 13 +++++-------- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/pattern-draft.md b/.github/ISSUE_TEMPLATE/pattern-draft.md index 3ba1451b9..acbe403de 100644 --- a/.github/ISSUE_TEMPLATE/pattern-draft.md +++ b/.github/ISSUE_TEMPLATE/pattern-draft.md @@ -7,7 +7,7 @@ assignees: '' --- -If you don't know how to get started, try to [draft an InnerSource Pattern with AI](meta/pattern-drafts-with-ai.md). +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). Then you can paste the result into the issue below, do manual edits as you see fit and submit it. Below you see a basic template for a new pattern. diff --git a/meta/pattern-drafts-with-ai.md b/meta/pattern-drafts-with-ai.md index 7688e5510..e1eabc460 100644 --- a/meta/pattern-drafts-with-ai.md +++ b/meta/pattern-drafts-with-ai.md @@ -3,18 +3,15 @@ Our AI friends can help us to brainstorm and write new InnerSource patterns. Usual precaution should apply, as always with AI ;) -Below we share various prompts and instructions for different API tools. - ## How to use this -How to use this prompt: - - Paste the below prompt into ChatGPT or your AI agent of choice. - Add a description of the **problem** you are looking to solve, as well as the intended **solution** (if you already have one in mind). -- Let AI do its magic -- Then populate the missing sections manually as you see fit. +- Let AI do its magic. +- Then populate the missing sections and adapt the pattern manually as you see fit. +- Finally, submit your work as a pull request to our repo. -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. +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. ## Prompt @@ -30,7 +27,7 @@ Further instructions: - These sections should contain the value "TBD": Known Instances, Author - These sections should be removed: Acknowledgments - 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. -- The value of the Status section should be "Initial" +- The value of the Status section should be "Initial". - The word "(optional)" should be removed from the headlines. This is the concept that I want to explain in the pattern: From d37a4cb9214dee408656d31f1a86c38ea13f82c6 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Mon, 6 Oct 2025 23:11:28 +0200 Subject: [PATCH 6/7] Fixes --- meta/pattern-drafts-with-ai.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/meta/pattern-drafts-with-ai.md b/meta/pattern-drafts-with-ai.md index e1eabc460..67cf66443 100644 --- a/meta/pattern-drafts-with-ai.md +++ b/meta/pattern-drafts-with-ai.md @@ -24,10 +24,10 @@ https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern Further instructions: - Each headline in the template starts a new section, with a distinct semantic purpose. - 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. -- These sections should contain the value "TBD": Known Instances, Author +- The value of these sections should be "TBD": Known Instances, Author +- The value of the Status section should be "Initial". - These sections should be removed: Acknowledgments - 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. -- The value of the Status section should be "Initial". - The word "(optional)" should be removed from the headlines. This is the concept that I want to explain in the pattern: From 64c26f0195a2abb727f7293ba92cbf2cfc4c2779 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Mon, 6 Oct 2025 23:13:11 +0200 Subject: [PATCH 7/7] Fix issue template --- .github/ISSUE_TEMPLATE/pattern-draft.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/pattern-draft.md b/.github/ISSUE_TEMPLATE/pattern-draft.md index acbe403de..cc49492e8 100644 --- a/.github/ISSUE_TEMPLATE/pattern-draft.md +++ b/.github/ISSUE_TEMPLATE/pattern-draft.md @@ -19,7 +19,8 @@ Short Title Here ## Patlet / Summary -Concise 1-2 sentence description of the problem and solution. +Concise 2 sentence description of the problem and solution. +The 1st sentence describes the problem. The 2nd sentence describes the solution. ## Problem