Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions .github/ISSUE_TEMPLATE/pattern-draft.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,20 @@ 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](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.
For the full details, see our [pattern template](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md).

## Title

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

Expand Down Expand Up @@ -59,7 +63,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

Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
36 changes: 36 additions & 0 deletions meta/pattern-drafts-with-ai.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# 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 ;)

## How to use this

- 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 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 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

```
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:
- 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.
- 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 word "(optional)" should be removed from the headlines.

This is the concept that I want to explain in the pattern:

<describe the problem and intended solution here in rough terms>
```
7 changes: 4 additions & 3 deletions meta/pattern-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading