Edit

仕様

All-contributorsのテーブルを使って、すべてのコントリビューターを認識する例

Contributors Table Screenshot

必須

All Contributorsの仕様を満たすために、オープンソースプロジェクトは次の必須項目を含める必要があります。

  1. プロジェクトのドキュメント内の主要な場所にある、すべてのコントリビューターのリストを含んだ、"コントリビューター"セクション
    • 可能であれば、プロジェクトの最も目立つ場所を使用することが目標です。 多くの場合、これはプロジェクトの README ファイルです。
    • Consider using a CONTRIBUTORS file in the top level of the repository when the number of project contributors exceeds a level at which it is unfeasible to use the README file to acknowledge contributions. この場合、READMEの"コントリビューター"見出しの下に、CONTRIBUTORSファイルへの目立つリンクを含めるべきです。
  2. リストは、プロジェクトのコントリビューターについての以下の情報が含まれているテーブル形式である必要があります:
    • 名前
    • コントリビューターについての詳細を学ぶことができるサイトへの URL リンク。 このURLはプロジェクトの判断によっては、コントリビューターによって決定されるかもしれません。
    • 定義済のコントリビューションカテゴリおよび/またはコントリビューションカテゴリemoji画像を使用してテキストまたはアイコン画像形式でのコントリビューションカテゴリの表示 (下記参照)
    • 定義済のコントリビューションカテゴリおよび/またはコントリビューションカテゴリemojiを使用してテキストやemoji形式でのコントリビューションカテゴリへのリンク
      • コントリビューターの一覧表は、必要に応じて、(技術的にはそれぞれ独自のテーブルである) 複数の行にわたって分割できます。
      • コントリビューターの順序はこの仕様では重要ではありません。 好きなように並べてください。
  3. プロジェクトは、どのレベルのどのコントリビューションカテゴリにおいても、プロジェクトへのコントリビューションを行う人をコントリビューターとして定義する必要があります。 この仕様は、定義上、すべてのコントリビューションを含んでいます。 プロジェクトがコントリビューションカテゴリから外れているか、プロジェクトのコントリビューターとしての基準を満たすために一定のコントリビューションレベルを要求する場合、CONTRIBUTINGドキュメントや類似のリポジトリのトップレベルにある人目につくドキュメント内において、コントリビューター基準の定義を明白にしなければなりません。 この仕様は、認められたコントリビューションのレベルに基づいてコントリビューターの一覧表からは個人を除外しないことをおすすめします。 代わりに、プロジェクトはコントリビューションの尺度を使用してどんなレベルのコントリビューションであってもプロジェクトのすべてのコントリビューターを一覧表に含めるようにすべきです。 このコントリビューション指標はプロジェクトによって決定されるものであり、現在は細かく規定されていません。

ヒント: @all-contributors ボット 🤖 を使用して、オープンソースプロジェクトへのコントリビューターを自動的に認識することができます ✨

任意

All Contributorsの仕様への取り組みの一環として、以下の任意項目を検討してください:

  1. ユーザーのアバターを含めることができます。また、含めることが推奨されています。
  2. 以下のセクションで詳しく説明するように、コントリビューションカテゴリを表しているものからカテゴリ特有のコントリビューションへの任意リンクを含めて、プロジェクトのコントリビューションに関してのさらに付加的な情報を与えることができます。

次は？

← 概要Emoji キー ✨ →