InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Improving the "Common Requirements" pattern

Open
#389 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

:book: Type - Content Work 2-structured
Dominant language
HTML
Stars
853
Forks
206
Avg merge
1d 23h
Merged PRs (30d)
2

Description

Some ideas for improving the Common Requirements pattern:

  • Improve the Patlet - escpecially describe how the Solution is improving upon the Problem
  • Break up Forces into bullets - so that readers can check more easily if these forces apply in their orgs as well
  • Decide what to do with the Resulting Context: It currently focuses mostly on other related challenges that may need to be solved after this pattern is in place. However it lacks explanation of how this pattern has helped to address the problem i.e. how can people confirm "did it work"?
  • improving the visual e.g. by creating a new version digitally (so no scan), and explaining in the pattern what that visual illustrates

To even level the pattern up to Validated, we would have to find 2 more Known Instances of orgs using this pattern. As this might be hard to do, it could be achieved in multiple steps (and PRs) over time.

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

Start by reading patterns/2-structured/common-requirements.md and the contributor handbook section linked in the issue, then inspect assets/img/CommonReqtsv2.jpg. Break the work into the listed pattern, visual, and validation improvements; done means the selected changes are documented and the pattern has the required evidence, including two additional Known Instances if pursuing Validated status.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.