InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

RFC Pattern improvements

Open
#276 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Further improvement ideas for the pattern:
https://patterns.innersourcecommons.org/p/transparent-cross-team-decision-making-using-rfcs

Previous PR with some further info about these topics:
https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/245

Topics:

  • Title / URL - a shorter title
    • Why? A shorter title would make it easier to reference the pattern (e.g. from other patterns), and shorter titles also look better in the table of contents in the book :) It would also lead to a shorter URL (the URL is actually depends on the filename, rather than on the Title of the pattern)
    • Ideas: Current title is "Transparent Cross-Team Decision Making using RFCs". Some ideas for shorter titles "Decision Making using RFCs", "Internal RFCs"
    • Last Feedback from Pattern author: Looks like this was discussed in the Patterns group and you're happy with it as is?
  • Sketch - Any type of visual that can be added to the pattern
    • Why? Any visual makes the pattern look prettier in the book. Of course it is nice if the visual also helps to understand the pattern.
    • Ideas: Could even be a screenshot of the RFC template? Or a screenshot of one of the RFCs from RUST or elsewhere?
    • Last Feedback from Pattern author: I was thinking about an image of the template, but I think text is better as it can be copy + pasted. Perhaps a process flow diagram would be good?

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 the linked pattern and the discussion in pull request #245. Confirm with the pattern author whether the title should change and which visual, if any, is wanted. Done means the agreed title and visual guidance are incorporated into the pattern.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.