新規ユーザー向けのクイックスタートガイド
Topics
誰がこのガイドを使うべきですか ?
あなたが初めて WordPress コアに貢献したい開発者なら、このガイドは Trac をナビゲートして使用するためのものです。これは、あなたがすぐに始められるように、ハイレベルな概要として意図されています。このページは、貢献する前に必要ないくつかの全体的な知識、チケットの作業の基本的なステップ、そして最後に Trac チケットのレイアウトを案内するものです。Trac の使い方をより深く学ぶために、コアハンドブックとチュートリアルを参照することを強くおすすめします。
ここでは、すでに WordPress.org アカウントを持っており、https://core.trac.wordpress.org/ を熟読され、ガイダンスやサポートを求めることができる make.wordpress.org の Slack ワークスペースにすでにアクセスされていると想定しています。
始める前に知っておくべきこと
Trac の機能
Trac はオープンソースであり、Web ベースのプロジェクト管理およびバグ追跡システムです。コア、メタ、テーマレビューを含む WordPress プロジェクトの多くの部分で使用されています。Trac はチケットで作業することを基本としています。貢献者は、作業が必要なチケットの発見、オープンチケットの状況の監視、WordPress コアへのパッチの貢献などにこのツールを活用します。
コア貢献者が Trac でどのようにコミュニケーションをとっているか
Trac は WordPress コアで行われた作業の公式な記録です。ここに書かれたチケットは、オープンソースへの貢献に関する生きた歴史的なドキュメントの一部となります。このため、チケットやコメントで使用されるトーンや言語は、フォーマルで要点を押さえたものであるべきです。
これは公式な記録であるため、記録したいバグや機能のチケットが存在しないかどうか、十分に検索してください。すでにある場合は、その既存のチケットにあなたのメモを追加してください。もし、あなたが追加しなければならないことが、既存のアイテムに関連していたり、マイルストーンが終了しているものであれば、チケット間のリンクを自動的に作成するために、#{ticket_id} というフォーマットを使ってそのチケットを参照してください:「これは以前 #99999で議論されました。」特定のチェンジセット (Trac に記録されたコード変更のセット) を参照する必要がある場合、[{changeset_id}}] というフォーマットでリンクできます:「元のバグが修正されたのは[999999]です。」なお、終了したマイルストーンチケットは決して再オープンしてはいけません。
貢献者はボランティアであり、このプロセスには時間がかかることを覚えておいてください。
オープンな Trac チケットでの作業
- https://make.wordpress.org/core/reports/ を使って、取り組むことが可能なチケットを探します。
- 添付ファイルを確認し、現在提案されているパッチがあるかどうかを確認します。
- パッチが存在しない場合は、シナリオを再現し、新しいパッチを追加する必要があります。
- パッチがある場合は、レビューとテストが必要で、コメントから現在の状況がわかります。パッチをダウンロードし、あなたの開発環境でテストしてください。期待通りに動作する場合は、適切なフィードバックを提供してください。
- パッチに変更を加えた場合は、コメントと合わせて Diff (https://make.wordpress.org/themes/handbook/review/working-with-trac/#comparing-ticket-updates) へのリンクも提供してください。
- チケットには、何を変更したか、なぜ変更したかを記述したコメントを必ず残してください。パッチのアップロードそのものは、通知のきっかけとはなりません。パッチへリンクするときは、コメントで [attachment:{filename}] を使用してください。
- 必要に応じてキーワードを調整するようにしてください: https://ja.wordpress.org/team/handbook/core/contribute/trac/keywords/
もし、その課題に対するチケットがまだ存在しない場合は、新しいチケットを開いてください: https://ja.wordpress.org/team/handbook/core/tutorials/trac/opening-a-ticket/
チケットの概要
Trac チケットの概要
- チケット ID 番号 – コメントの際は、チケット間のリンクを自動的に作成するため、#{ticket_id} のフォーマットを使用してください。
- タイプ –
- Defect (bug): 何か問題があり、修正する必要があります。
- Enhancements: フックの追加やその他の修正のような、既存の機能の改善です。
- Feature requests: WordPress コアや他の Trac チケットにない新しいアイテムです。
- Tasks (blessed): このオプションは、新しいチケットを提出するときには表示されません。このステータスは、機能チームがそのチケットを開発対象として受け入れた場合にのみ与えられます (「blessed」というのはそのためです)。
- マイルストーン – デフォルトで「Awaiting Review」に設定されています。開発が承認されると、これはリリース予定の特定のバージョン番号に設定されます。マイルストーンを設定できるのは、信頼されたコア貢献者のみです。
- 重要度 – normal、major、minor、trivial、critical、または blocker。信頼できるコア貢献者のみが重要度を変更できます。
- コンポーネント – プロジェクトのどの部分に取り組んでいるのか ? 各コンポーネントの詳細な定義については、https://make.wordpress.org/core/components/ を参照してください。
- フォーカス – チケットを作成する際にオプションで設定します。これは、チケットが WordPress コンポーネントの複数の領域に関連しているかどうかを示します。選択肢は ui、accessibility、javascript、docs、rtl、admin、template、multisite、rest-api、performance、coding-standards です。
- 優先度 – この問題をどの程度早く対処すべきか。選択肢は normal、low、high、lowest、highest omg bbq です。信頼されたコア貢献者と別のステータスについて話し合ったことがない限り、「normal」を使用する必要があります。
- バージョン (バグの場合) – このバグの影響を受ける WordPress の最も古い既知のバージョンです。これを変更するべきではありません。
- キーワード – これはタグのようなもので、チケットの現在のステータスと必要な次のステップを追跡するために使用されます。これは、作業の進行に応じて変更されます。利用可能な選択肢に関する詳細な定義については、以下を参照してください: https://ja.wordpress.org/team/handbook/core/contribute/trac/keywords/
- 説明文 – チケットの中心となる部分です。できるだけ詳しく、具体的に書いてください。バグの場合は、問題を再現するための手順と、期待することを記載してください。
- 添付ファイル – スクリーンショット、新しいパッチ、パッチの差分ファイルなど、追加情報を追加します。
- 変更履歴 – ここで会話が行われます ! デフォルトで開かれているため、作業を始める前に最後まで読んで、何が試されたのか、他の人は何を積極的に行っているのかを確認する必要があります。
リソース
上記インフォグラフィックの印刷用高解像度画像は、JPG と PDF のフォーマットで提供されています。
最終更新日: