Upgrade to Pro — share decks privately, control downloads, hide ads and more …

InnerSource Pattern: ベース・ドキュメンテーション

InnerSource Pattern: ベース・ドキュメンテーション

概要
パターンの著者: Isabel Drost-Fromm
スピーカー/翻訳: Yuki Hattori | LinkedIn | Twitter | GitHub
YouTube: ベース・ドキュメンテーション
Docs: ベース・ドキュメンテーション

「InnerSource Pattern: ベース・ドキュメンテーション」
インナーソースプロジェクトへの新しいコントリビューターは、誰がプロジェクトを維持し、何に取り組み、どのようにコントリビューションすればよいかを理解するのに苦労しています。`README.md`/`CONTRIBUTING.md` のような標準ファイルでドキュメントを提供することで、新しいコントリビューターのためのセルフサービスなプロセスを可能にし、よくある質問に対する答えを自分自身で見つけることができるようにします。

リンク
InnerSource Patterns: English 🇬🇧| 日本語 🇯🇵
Website: innersourcecommons.org
Slack: Invite Link | 🇯🇵#jp-general
Twitter: @InnerSourceJP (日本) | @InnerSourceOrg (公式)

Avatar for Yuki Hattori

Yuki Hattori

January 13, 2023
Tweet

More Decks by Yuki Hattori

Other Decks in Technology

Transcript

  1. README.md まだ存在しない場合は、あなたのプロジェクトの README.md を作成してください。それには以下の内容が 含まれていなければなりません。 プロジェクトのミッション プロジェクトで実働をするユーザーに向けた "Getting Started" セクション。

    プロジェクトユーザーのための詳細なドキュメント - またはそれへのリンク プロジェクトを修正するために必要なドキュメント - またはそれへのリンク プロジェクトにコントリビュートする方法に関するドキュメント - またはそれへのリンク プロジェクトがどのようなアクセス可能なパブリックもしくはアーカイブのコミュニケーションチャネ ルを用いているかを説明する "Getting involved" セクション。 プロジェクトを支える トラステッドコミッターが誰であるかを説明する "Who we are" のセクション。 プロジェクトが貢献者をトラステッドコミッターにするための基準の説明。 コントリビューターがそのプロジェクトにおけるトラステッドコミッターになるための基準及び、その パスが存在するならばそのパス InnerSource Patterns: ベース・ドキュメンテーション @yuhattor 7
  2. CONTRIBUTING.md コントリビューションを行うための手順の説明が複雑すぎる場合は、 CONTRIBUTING.md というドキュメン トを別に作成します。この文書では、コントリビューターが過去によく聞かれた質問に答えるようにしま す。前もって包括的なドキュメントを提供する必要はありません。むしろ、コントリビューターが必要とし ていることが証明された情報を共有しましょう。おそらく、以下のトピックのうちの1 つ以上に触れること になるでしょう。 プロジェクトのソースコードをバージョン管理からチェックアウトする方法

    プロジェクトに変更を加える方法 ( コーディングガイドラインに関する情報を含む可能性があります) プロジェクトをビルドする方法 上記の修正が新しいバグを引き起こしていないことを確認するためのテストの実行方法 プロジェクトにあなたの修正をサブミットする方法 修正が行われた場合、変更が取り込まれるまでに必要な所要時間に関する情報 InnerSource Patterns: ベース・ドキュメンテーション @yuhattor 8
  3. CONTRIBUTING.md 様々なオープンソースプロジェクトにおいて、README.md の書き方 や、CONTRIBUTING.md ファイルにどのような情報を含めるべきか についての良い例がたくさんあります How to write a

    readme that rocks Open Source Guide from GitHub Producing Open Source Producing Open Source の Getting Started chapter には、ホストチームのメ ンバー、ユーザー、コントリビューターが必要とするもののかなり広範な リストがあります このパターンには、すぐに始められるように、2 つの非常に基本的 なテンプレートが付属しています README-template.md CONTRIBUTING-template.md InnerSource Patterns: ベース・ドキュメンテーション @yuhattor 9
  4. 事例 Europace AG - こちらのブログをご覧ください InnerSource: Adding base documentation Paypal

    Inc. InnerSource Patterns: ベース・ドキュメンテーション @yuhattor 11
  5. InnerSource についてもっと知る InnerSource Commons: https://innersourcecommons.org Join our Slack community: https://innersourcecommons.org/slack

    InnerSource Patterns: https://patterns.innersourcecommons.org Twitter: @InnerSourceOrg 日本語 Slack チャンネル: #jp-general 日本語 Twitter: @InnerSourceJP InnerSource Patterns: ベース・ドキュメンテーション @yuhattor 13