Skip to content

Latest commit

 

History

History
90 lines (46 loc) · 5.23 KB

CONTRIBUTING.md

File metadata and controls

90 lines (46 loc) · 5.23 KB

貢献に関するガイド

Awesome japanese a11y companiesへ貢献する際に参考となるガイドです。

事例の受け入れ条件

このAwesome Listsはアクセシビリティに取り組む・推進している日本企業まとめです。

以下2点を満たしているものであれば貢献できます。

  • 日本企業である(注意:日本法人ではない)
  • 企業でアクセシビリティに取り組んでいることが分かる事例(アクセシビリティ方針、事業サービス、チームの取り組み等)である

アクセシビリティにまつわる紹介や関連する技術に触れてみただけの、企業の取り組みではなく個人の取り組みのものついては現在取り扱わないようにしています。accrefsへ情報提供することをおすすめします。

事例を貢献する際は、その企業所属してない方でも情報提供していただいて問題ありません。

イシューで報告する手順

このリポジトリに貢献するには、以下の手順に従ってください。

1. イシューを作成する

新しくイシューを作るより、新しいイシューを作成してください。

2. イシューを埋める

以下の項目を埋めてください。

  • 企業名
  • 企業のアクセシビリティに関する事例(アクセシビリティ方針、事業サービス、チームの取り組み等)

3. イシューを登録する

入力が完了したらイシューを登録してください。内容が問題ないのを確認次第、管理人(@yamanoku)が追加していきます。

掲載する内容にそぐわない場合はイシューをクローズする可能性もあります。その点ご了承ください。

プルリクエストを作成する手順

このリポジトリに貢献するには、以下の手順に従ってください。

1. リポジトリをフォークする

このリポジトリをフォークしてください。

手順についてはリポジトリをフォークする - GitHub Docsを参考ください。

2. ブランチを作成する

git checkout -b <branch-name> を実行して、新しいブランチを作成してください。

手順についてはリポジトリ内でブランチを作成および削除する - GitHub Docsを参考ください。

3. ファイルを編集する

該当するファイルを編集して、事例タイトルとURLをリスト形式で追加していってください。

事例を追加する企業がない場合は、新たに企業名も追加してください。企業名の順番は50音順になるようにしてください(追加参考例)。

4. プルリクエストを作成する

ファイルを編集しコミットまで完了したら、プルリクエストを作成してください。

手順についてはフォークからプルリクエストを作成する - GitHub Docsを参考ください。

5. レビュー

管理人(@yamanoku)がプルリクエストをレビューします。

問題なければそのままマージします。修正が必要な場合はコメントをするため、それに従った修正をお願いします。

掲載する内容にそぐわない場合はプルリクエストをクローズする可能性もあります。その点ご了承ください。

取り扱う言語について / Language

管理人(@yamanoku)が日本人であることと、日本での企業内容を扱う都合、イシューやプルリクエストでは基本的に日本語でやり取りできるようお願いします。

日本語を扱うのが難しい場合は、オンライン翻訳ツールを利用して日本語に変換していただけることが望ましいです。


Please note that the administrator (@yamanoku) is Japanese and that we deal with corporate content in Japan, communicate in Japanese for issues and pull requests.

If you have difficulty dealing with Japanese, it is preferable that you use an online translation tool to convert your work into Japanese.

連絡について

貢献していただいてから、管理人(@yamanoku)が確認や追加するまでに時間がかかる場合があります。2週間以上経っても追加されない場合は、お手数ですが、登録したイシューやプルリクエストのコメントで@yamanoku宛にご連絡をお願いします。