InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

ultra-short, illustrative story for patterns

Open
#152 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

:gear: Type - Meta
Dominant language
HTML
Stars
853
Forks
206
Avg merge
1d 23h
Merged PRs (30d)
2

Description

Story provides a more narrative, less academic description to a pattern. When a pattern has a good narrative description at the first few sections, it helps people deciding quickly whether this is something they want to dive deeper. Some patterns provide good narrative while some other patterns lack those narrative angle. It would help to add story or improve narrative description to the patterns that don't have good narratives.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named in the issue. Review the repository's pattern documents and identify entries whose opening sections lack a concise narrative; done means the selected patterns have useful stories that help readers decide whether to explore further.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.