コンテンツにスキップ
All Contributors

仕様

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

A screenshot of github showing a comment that says please add @user for docs.

必須

Section titled “必須”

Open source projects should include the following mandatory items to support the All Contributors specification:

  1. プロジェクトのドキュメント内の主要な場所にある、すべてのコントリビューターのリストを含んだ、“コントリビューター”セクション
    • 可能であれば、プロジェクトの最も目立つ場所を使用することが目標です。 In many cases, this is the project README.md file
    • 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画像を使用してテキストまたはアイコン画像形式でのコントリビューションカテゴリの表示 (下記参照)
    • A link to the Contribution Category in text or emoji format using the defined Contribution Categories and/or Contribution Categories emoji.
      • The list of contributors can be spread across multiple lines (each technically being its table) as needed.
      • コントリビューターの順序はこの仕様では重要ではありません。 好きなように並べてください。
  3. プロジェクトは、どのレベルのどのコントリビューションカテゴリにおいても、プロジェクトへのコントリビューションを行う人をコントリビューターとして定義する必要があります。 この仕様は、定義上、すべてのコントリビューションを含んでいます。 In cases where projects deviate from the Contribution Categories or require a specific contribution level to meet criteria as a project contributor, the project should provide explicit documentation of the definitions that satisfy the project contributor criteria in the CONTRIBUTING document or a similar prominent public document at the top level of the project repository. この仕様は、認められたコントリビューションのレベルに基づいてコントリビューターの一覧表からは個人を除外しないことをおすすめします。 代わりに、プロジェクトはコントリビューションの尺度を使用してどんなレベルのコントリビューションであってもプロジェクトのすべてのコントリビューターを一覧表に含めるようにすべきです。 このコントリビューション指標はプロジェクトによって決定されるものであり、現在は細かく規定されていません。

任意

Section titled “任意”

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

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