InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Help pattern authors with Context + Forces

Open
#419 5 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

Pattern authors often struggle with filling in the Context + Forces sections of our pattern template.

Could we give them more guidance on how to fill in Context + Forces?

@NewMexicoKid you are dropping nuggets of wisdom about these sections in your reviews sometimes (as in the example below). Could you help us extend the pattern template with further instructions, especially around these two sections?

Example of "nuggets of wisdom"

Whenever possible, forces should be stated in a way that indicates the trade-offs (which can hint at the levers by which one can react to a given force).

So if Product Owners are reluctant to be more collaborative and transparent, what is motivating them to do so? (Is it a cultural tendency to secrecy to protect proprietary information to gain a strategic advantage? If so, then is it a matter of noting which information needs to be protected vs. which info, when shared, can result in compensating advantages?)

Originally posted by @NewMexicoKid in https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/417#discussion_r878929031

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

Locate the pattern template referenced by the issue and review its existing Context and Forces guidance. Compare the template with the quoted review advice, then update those sections with clearer instructions; done means pattern authors have actionable guidance in the template.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.