InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

RFC Pattern improvements

Offen
#276 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

:book: Type - Content Work
Vorherrschende Sprache
HTML
Sterne
853
Forks
206
Ø Merge
1 T. 23 Std.
Gemergte PRs (30 T.)
2

Beschreibung

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?

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, das verlinkte Pattern und die Diskussion in Pull Request #245 zu lesen. Kläre mit dem Autor des Patterns, ob der Titel geändert werden sollte und welches Visual, falls überhaupt eines, gewünscht ist. Erledigt ist die Aufgabe, wenn der vereinbarte Titel und die Vorgaben zum Visual in das Pattern übernommen wurden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
content, documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
20/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.