MDN への協力
MDN Web Docs はあなたの協力を必要としています。膨大な数の修正すべき記述ミス、書くべき例、修正すべきバグ、相談相手などあり、その数はこのサイトを使い始める人が増えるにつれて増えています。このページでは、皆さんができることをまとめています。
メモ: 初めて MDN に協力する人は、 MDN で始めよう のガイドで手順を簡単な 4 つのステップで説明しています。都合がいいことに、あなたはすでにステップ 2 の「協力できるものを探す」の段階にいます。
協力するためにできること
MDN に貢献するには、あなたの持つスキルセットや興味に応じて、様々な方法があります。それぞれのタスクには、簡単な説明と、それぞれのタスクにかかるおおよその時間が記載されています。
何をすればよいか分からない人は、いつでも助けを求めてください。
主な貢献の種類
この節のリンクは、重要な機能であったり、膨大なバックログを抱えていたりして、コミュニティの支援を最も必要としている特定の協力タスクについて、その方法を説明する詳細なガイドにつながっています。他の方法での協力を検討する前に、これらのタスクへの協力をご検討ください。
タスク | 解説 | 必要なスキル |
---|---|---|
MDN のコンテンツのバグ修正 | MDN の文書で見つかった問題は、コンテンツリポジトリーに報告されます。数多くのコンテンツバグがあるので、それらの修正に協力していただけるととても助かります。 |
|
MDN の編集のレビュー | MDN のコンテンツを更新するために、コンテンツリポジトリーにプルリクエストが提出されますので、そのレビューに協力が必要です。 REVIEWING.md ページでは、レビュープロセスの仕組みや、どのようにレビューに参加できるかについて説明しています。 |
|
初心者が MDN で学ぶのに協力する | ウェブ開発を学ぶページには、毎月 100 万以上の閲覧があり、一般的なヘルプを求めたり、評価の採点を依頼したりするためのアクティブなフォーラムがあります。投稿に解答したり、学習コミュニティを成長させたりする手伝いをしてくださると幸いです。 |
|
ここには、時間の経過とともにタスクを追加していきます。
優先順位
優先度も見ることで、どの作業が最も重要なのかを知ることができます。コンテンツのバグ問題には、重要度を示すために、P0、P1、P2、P3、P4 というラベルを付け始めました。数字が小さいものは、数字が大きいものより高い優先度です。
これらは、 MDN ドキュメントの優先順位リストに基づいて、通常の MDN バグのトリアージプロセスの中で把握されます。
その他の種類の作業
上記の優先事項に興味がわかない場合は、スキルセットごとに分けられた、より一般的な種類のタスクを以下に紹介します。
言葉に興味がある方は、以下のことができるでしょう。
- 既存の記事を新しい情報に更新する (5 分 - 1 時間)
- 用語集に新しい項目を書く (15 分 - 1 時間)
コードのほうが興味がある人は、以下のことに挑戦してみてください。
- コードサンプルを「ライブ」に変換 (30 分)
- Yari のコードベースにコードパッチを送る (1 時間)
- インタラクティブな例を書く (1 時間)
言葉とコードの両方に興味があるなら、以下のことに挑戦してみてください。
- API リファレンスを書いたり更新したりする (30 分から 2 時間以上)
- なじみのある分野のトピックで新しい記事を書く (1 時間以上)
- リファレンスページのブラウザー互換性データを追加したり更新したりする (30 分から 1 時間)
メモ: MDN 上で誤りを見つけたものの、それを修正する方法が分からない場合、ドキュメントの問題を提出することで問題を報告することができます。その際、問題を説明するタイトルを付けてください。(どこでリンクを見つけたかを書かずに「リンク切れ」と言っても役に立ちません。)
その他の有用なページ
- 文書作成のプロセス
MDN 文書作成プロジェクトは非常に大規模です。カバーするべき莫大な数の技術があり、数百人の貢献者が世界中に散らばっています。秩序をもたらすために、従うべき標準の手順を定め、特定の文書化関連の作業を行うときにはこれに従います。ここでは、これらの手順についてのガイドを紹介します。