MDN への貢献
MDN Web Docs はあなたの協力を必要としています。膨大な数の修正すべき記述ミス、書くべき例、修正すべきバグ、相談相手などあり、その数はこのサイトを使い始める人が増えるにつれて増えています。このページでは、皆さんができることをまとめています。
注: 初めて MDN に協力する人は、 MDN で始めよう のガイドで手順を簡単な 4 つのステップで説明しています。都合がいいことに、あなたはすでにステップ 3 の「協力できるものを探す」の段階にいます。
協力するためにできること
MDN に貢献するには、あなたの持つスキルセットや興味に応じて、様々な方法があります。それぞれのタスクには、簡単な説明と、それぞれのタスクにかかるおおよその時間が記載されています。
何をすればよいか分からない人は、いつでも助けを求めてください。
主な貢献の種類
この節のリンクは、重要な機能であったり、膨大なバックログを抱えていたりして、コミュニティの支援を最も必要としている特定の協力タスクについて、その方法を説明する詳細なガイドにつながっています。他の方法での協力を検討する前に、これらのタスクへの協力をご検討ください。
| タスク | 解説 | 必要なスキル |
|---|---|---|
| MDN のコンテンツのバグ修正 | MDN の文書で見つかった問題は、コンテンツリポジトリに報告されます (古い sprints リポジトリにも修正すべきバグがありますが、いずれ閉鎖する予定です)。数多くのコンテンツバグがあるので、それらの修正に協力していただけるととても助かります。 |
|
| MDN の編集のレビュー | MDN のコンテンツを更新するために、コンテンツリポジトリにプルリクエストが提出されますので、そのレビューに協力が必要です。 REVIEWING.md ページでは、レビュープロセスの仕組みや、どのようにレビューに参加できるかについて説明しています。 |
|
| 初心者が MDN で学ぶのに協力する | ウェブ開発を学ぶページには、毎月 100 万以上の閲覧があり、一般的なヘルプを求めたり、評価の採点を依頼したりするためのアクティブなフォーラムがあります。投稿に解答したり、学習コミュニティを成長させたりする手伝いをしてくださると幸いです。 |
|
ここには、時間の経過とともにタスクを追加していきます。
優先順位
優先度も見ることで、どの作業が最も重要なのかを知ることができます。コンテンツのバグ問題には、重要度を示すために、P0、P1、P2、P3、P4 というラベルを付け始めました。数字が小さいものは、数字が大きいものより高い優先度です。
これらは、 MDN ドキュメントの優先順位リストに基づいて、通常の MDN バグ・トリアージ・プロセスの中で把握されます。
その他の種類の作業
上記の優先事項に興味がわかない場合は、スキルセットごとに分けられた、より一般的な種類のタスクを以下に紹介します。
言葉に興味がある方は、以下のことができるでしょう。
- 既存の記事を新しい情報に更新する (5 分 - 1 時間)
- 用語集に新しい項目を書く (15 分 - 1 時間)
コードのほうが興味がある人は、以下のことに挑戦してみてください。
- コードサンプルを「ライブ」に変換 (30 分)
- Yari のコードベースにコードパッチを送る (1 時間)
- インタラクティブな例を書く (1 時間)
言葉とコードの両方に興味があるなら、以下のことに挑戦してみてください。
- API リファレンスを書いたり更新したりする (en-US) (30 分から 2 時間以上)
- なじみのある分野のトピックで新しい記事を書く (1 時間以上)
- リファレンスページのブラウザー互換性データを追加したり更新したりする (30 分から 1 時間)
注: MDN 上で誤りを見つけたものの、それを修正する方法が分からない場合、ドキュメントの問題を提出することで問題を報告することができます。その際、問題を説明するタイトルを付けてください。(どこでリンクを見つけたかを書かずに「リンク切れ」と言っても役に立ちません。)
その他の有用なページ
- GitHub 早見表
この記事では、 MDN に協力するために Git と GitHub を使用する際に必要となる基本的なコマンドのクイックリファレンスを提供します。これらのツールに慣れておらず、助けが必要な場合は、全くの初心者のための GitHub チュートリアルで基本的なことを教えています。
- MDN Web Docs についてのフィードバックを送る
MDN Web Docs への提案があったり、利用していて問題があったりした場合は、ここが正しい場所です。フィードバックを送ることに興味を持っていただいたことで、 Mozilla コミュニティの一員であることを実感していただけると思います。興味を持ってくださり、ありがとうございます。
- MDN web docs: How-to ガイド
ここにある記事は、MDN に貢献する際に具体的な目標を達成するためのステップごとのガイドを提供するものです。
- MDN コンテンツのバグ修正
MDN の文書に関する問題は、コンテンツリポジトリーの課題 (issue) として報告されます (また、以前の sprints リポジトリーにも未解決の課題があります)。この記事では、あなたの専門知識と作業可能な時間に基づいて、作業するのに最適な問題を見つけ、それらを修正するための主な手順を概説します。
- MDN で始めよう
私たちは開発者のオープンなコミュニティであり、ブランドやブラウザー、プラットフォームを問わず、ウェブをより良くするリソースを構築しています。誰でも協力でき、それによってコミュニティはより強固なものとなります。ともに協力することで、ウェブをより良いものへ革新していく後押しを継続できます。ここから、あなたと始まります。
- MDN の Markdown
このページでは、 Markdown を使用してどのように MDN のドキュメントを書くかを説明します。ベースラインとして GitHub-Flavored Markdown (GFM) を選択し、 GFM では容易にサポートされていない MDN で行う必要のあるいくつかのことに対応するために、いくつかの拡張機能を追加しました。
- MDN のための GitHub のベストプラクティス
このページでは、 MDN に協力するために GitHub を使用する際のベストプラクティスを、主に課題 (issues) の扱い方を中心にご紹介します。
- MDN のローカライズ
2020 年 12 月 14 日より、MDN は GitHub ベースの新しい Yari プラットフォームで運用しています。これは MDN にとって多くの利点がありますが、ローカライズを扱う方法を大幅に変更する必要がありました。というのも、アメリカ英語以外のロケールでは、保守されていない古いコンテンツが多く存在しているため、今後はそれらをより適切に管理していきたいと考えているからです。
- MDN への貢献の変更履歴
この文書は MDN コンテンツのプロセス、構造、ベストプラクティスが変更されたこと、いつ変更されたかを記録するものです。これは、定期的に協力する人が、 MDN のコンテンツ作成プロセスで何が変わったかを確認するのに役立ちます。
- MDN 上のものはどこにあるのか - リポジトリのガイド
MDN は、たくさんの変化する部分がある複雑なプロジェクトです。 GitHub の知識を少し持っていて、簡単なタイプミスの修正やコードスニペットの改良から始めるのであれば、サイトへの貢献は簡単です。しかし、新しいページ全体を追加するなど、もっと大きな貢献を行おうとすると、ページのソースには格納されていない、どこか別の場所から来たコンテンツがかなりあることに気づくでしょう。
- MDN 文書化の優先順位リスト
訳注: この文書は英語版の原文を対象としたものです。アクセス頻度やページ数などは、すべて英語版のものです。
- オープンソースプロジェクトのための基本的なエチケット
オープンソースプロジェクト (OSP) で作業したことがない方は、 MDN (または他のオープンソースプロジェクト) への協力を始める前に、この記事を読むことをお勧めします。あなたや他のプロジェクトの協力者が大切にされ、安全であると感じ、生産性を維持するために採用すべきベストプラクティスがいくつかあります。
- 全くの初心者のための GitHub
Git と GitHub は学習したり使いこなしたりするのが難しいツールですが、いくつかの簡単なコマンドと適切なアドバイスがあれば、 MDN への協力を始めるのに十分な程度のことが、さほど苦労せずにできるはずです。この記事の目的は、 Git や GitHub を使いこなすことではなく、基本的なレベルで生産的になり、 MDN に協力するために必要なことを紹介することです。
- 初心者が MDN で学習するのを支援しましょう
ウェブ開発を学ぶのページ群は、毎月 100 万回以上の閲覧があり、一般的な助けを求めたり、評価の採点を依頼したりするためのアクティブなフォーラムがあります。投稿に回答したり、学習コミュニティを成長させたりする手伝いをしてくださると幸いです。
- 文書作成のプロセス
MDN 文書作成プロジェクトは非常に大規模です。カバーするべき莫大な数の技術があり、数百人の貢献者が世界中に散らばっています。秩序をもたらすために、従うべき標準の手順を定め、特定の文書化関連の作業を行うときにはこれに従います。ここでは、これらの手順についてのガイドを紹介します。