メインコンテンツまでスキップ
バージョン: master

貢献ガイド (Contribution Guide)

バグレポート (Bug Reports)​

積極的なコラボレーションを促進するために、Laravel ではバグレポートだけでなくプルリクエストを強く推奨しています。プル リクエストは、(「ドラフト」状態ではなく) 「レビュー準備完了」としてマークされ、新機能のすべてのテストが合格した場合にのみレビューされます。 「ドラフト」状態のまま残された非アクティブなプル リクエストは、数日後に閉じられます。

ただし、バグレポートを提出する場合は、問題のタイトルと明確な説明を含める必要があります。また、できるだけ多くの関連情報と、問題を示すコード サンプルも含める必要があります。バグ レポートの目的は、自分自身や他の人がバグを再現し、修正を開発しやすくすることです。

バグ レポートは、同じ問題を抱えている他の人が協力して解決できることを期待して作成されることに注意してください。バグレポートに何らかのアクティビティが自動的に表示されることや、他の人がそれを修正するために飛びつくことを期待しないでください。バグ レポートを作成すると、自分自身や他の人が問題解決の道を歩み始めるのに役立ちます。協力したい場合は、問題トラッカーにリストされているバグ を修正することで支援できます。 Laravel の問題をすべて表示するには、GitHub で認証される必要があります。

Laravel の使用中に不適切な DocBlock、PHPStan、または IDE の警告に気付いた場合は、GitHub の問題を作成しないでください。代わりに、問題を修正するにはプルリクエストを送信してください。

Laravel のソース コードは GitHub で管理されており、Laravel プロジェクトごとにリポジトリがあります。

サポートに関する質問 (Support Questions)​

Laravel の GitHub 問題トラッカーは、Laravel のヘルプやサポートを提供することを目的としたものではありません。代わりに、次のいずれかのチャネルを使用してください。

コア開発のディスカッション (Core Development Discussion)​

Laravel フレームワーク リポジトリの GitHub ディスカッション掲示板 で、新しい機能や既存の Laravel 動作の改善を提案できます。新しい機能を提案する場合は、その機能を完成させるために必要なコードの少なくとも一部を実装してください。

バグ、新機能、既存機能の実装に関する非公式のディスカッションは、Laravel Discordサーバー の #internals チャネルで行われます。 Laravel のメンテナである Taylor Otwell は通常、平日の午前 8 時から午後 5 時 (UTC-06:00 またはアメリカ/シカゴ) までチャネルに存在し、それ以外の時間帯にも散発的にチャネルに存在します。

どの支店ですか？ (Which Branch?)​

すべてのバグ修正は、バグ修正をサポートする最新バージョン (現在 12.x) に送信する必要があります。バグ修正は、今後のリリースにのみ存在する機能を修正するものでない限り、master ブランチには決して送信しないでください。

現在のリリースと 完全に下位互換性があるマイナー**機能は、最新の安定したブランチ (現在 12.x) に送信される場合があります。

主要な新機能または重大な変更を伴う機能は、次のリリースが含まれる master ブランチに常に送信する必要があります。

コンパイルされたアセット (Compiled Assets)​

laravel/laravel リポジトリの resources/css または resources/js 内のほとんどのファイルなど、コンパイル済みファイルに影響を与える変更を送信する場合は、コンパイル済みファイルをコミットしないでください。サイズが大きいため、現実的にはメンテナがレビューすることはできません。これは、悪意のあるコードを Laravel に挿入する方法として悪用される可能性があります。これを防御的に防ぐために、すべてのコンパイル済みファイルは Laravel メンテナによって生成およびコミットされます。

セキュリティの脆弱性 (Security Vulnerabilities)​

Laravel 内でセキュリティ脆弱性を発見した場合は、Taylor Otwell ([email protected]) へメールを送信してください。すべてのセキュリティ脆弱性は速やかに対応されます。

コーディングスタイル (Coding Style)​

Laravel は、PSR-2 コーディング標準と PSR-4 オートロード標準に従っています。

PHPDoc​

以下は、有効な Laravel ドキュメント ブロックの例です。 @param 属性の後には 2 つのスペース、引数の型、さらに 2 つのスペース、そして最後に変数名が続くことに注意してください。

/**
 * Register a binding with the container.
 *
 * @param  string|array  $abstract
 * @param  \Closure|string|null  $concrete
 * @param  bool  $shared
 * @return void
 *
 * @throws \Exception
 */
public function bind($abstract, $concrete = null, $shared = false)
{
    // ...
}

@param 属性または @return 属性がネイティブ タイプの使用により冗長である場合、それらは削除できます。

/**
 * Execute the job.
 */
public function handle(AudioProcessor $processor): void
{
    // ...
}

ただし、ネイティブ タイプがジェネリックの場合は、@param または @return 属性を使用してジェネリック タイプを指定してください。

/**
 * Get the attachments for the message.
 *
 * @return array<int, \Illuminate\Mail\Mailables\Attachment>
 */
public function attachments(): array
{
    return [
        Attachment::fromStorage('/path/to/file'),
    ];
}

スタイルCI​

コードのスタイルが完璧でなくても心配する必要はありません。 StyleCI は、プルリクエストがマージされた後、スタイル修正を自動的に Laravel リポジトリにマージします。これにより、コード スタイルではなく、投稿の内容に集中できるようになります。

行動規範 (Code of Conduct)​

Laravel の行動規範は、Ruby の行動規範から派生しています。行動規範の違反は、Taylor Otwell ([email protected]) に報告される場合があります。

  • 参加者は反対意見にも寛容になります。
  • 参加者は、自分の言語や行動に個人攻撃や個人を軽蔑する発言がないことを確認する必要があります。
  • 他者の言葉や行動を解釈するとき、参加者は常に善意を想定する必要があります。
  • ハラスメントと合理的にみなされる行為は容認されません。