InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Acknowledging all contributions/contributors
まだ誰も着手していません。
- 主要言語
- HTML
- スター
- 853
- フォーク
- 206
- 平均マージ
- 1日 23時間
- マージ済み PR(30日)
- 2
説明
GitHub has a way to show the people that committed (code) to this project. However by default only very few people are shown, and there is no further information about what they have contributed either.
As our community grows, it would be great to acknowledge the broad range of people that are supporting our patterns in all sorts of ways, not just the ones contributing code/patterns.
Implementation thoughts
I have heard good things about the all-contributors spec and bot but I don't know how it works in practice.
Their claim is:
Recognize All Contributors - Including those that don't push code
However their documentation looks like users need a GitHub handle to be added as contributors, which seems counter intuitive.
I am taking inspiration from The Turing Way project, who are using the tool for years.
We could review their implementation notes. Some links to get started:
- https://github.com/alan-turing-institute/the-turing-way/blob/main/contributors.md#record-of-contributions
- https://github.com/alan-turing-institute/the-turing-way/blob/main/CONTRIBUTING.md#recognising-contributions
- https://github.com/alan-turing-institute/the-turing-way/issues/274
- https://github.com/alan-turing-institute/the-turing-way/issues/446
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リンク先のTuring Wayのcontributors.mdとCONTRIBUTING.mdのセクションを読み、続いてall-contributorsの仕様とbotのドキュメントを確認してください。GitHubハンドルを持たないコントリビューターを含め、このプロジェクトでコードによる貢献とコード以外の貢献をどのように表現すべきかを判断してください。選択した功績認定の方法とその保守プロセスについて合意し、文書化されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- github
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100