본문으로 건너뛰기
버전: 13.x

Contribution Guide

Bug Reports​

활발한 협업을 장려하기 위해 Laravel은 GitHub 이슈보다 문제를 해결하는 풀 리퀘스트를 적극적으로 권장합니다. 대부분의 공식 패키지에서는 GitHub 이슈를 비활성화하고 있습니다.

문제를 발견했다면 해당 문제를 해결하는 풀 리퀘스트를 생성해 주세요. 풀 리퀘스트에는 제목과 문제 및 해결 방법에 대한 명확한 설명을 포함해야 합니다. 또한 가능한 한 관련 정보를 많이 포함하고, 문제를 보여 주는 코드 샘플도 첨부해야 합니다. 풀 리퀘스트의 목적은 자신과 다른 사람들이 문제를 쉽게 이해하고 수정 사항을 확인할 수 있도록 하는 것입니다.

문제를 해결하는 방법을 모른다면 코딩 에이전트에게 문제를 설명하고, 이를 사용해 풀 리퀘스트를 시도합니다.

풀 리퀘스트는 "ready for review"로 표시되어 있고("draft" 상태가 아니어야 함) 새로운 기능에 대한 모든 테스트가 통과한 경우에만 검토합니다. "draft" 상태로 남아 있는 장기간의 비활성 풀 리퀘스트는 며칠 후에 종료합니다.

Laravel 소스 코드는 GitHub에서 관리되며, 각 Laravel 프로젝트마다 저장소가 있습니다.

Support Questions​

Laravel의 GitHub 이슈 트래커는 Laravel 도움말이나 지원을 제공하기 위한 곳이 아닙니다. 대신 다음 채널 중 하나를 이용하세요.

Which Branch?​

모든 버그 수정은 버그 수정을 지원하는 최신 버전(현재 13.x)으로 보내야 합니다. 다가오는 릴리스에만 존재하는 기능을 수정하는 경우가 아니라면, 버그 수정은 절대로 master 브랜치로 보내서는 안 됩니다.

현재 릴리스와 완전히 하위 호환되는 마이너 기능은 최신 안정 브랜치(현재 13.x)로 보낼 수 있습니다.

메이저 새 기능이나 호환성을 깨는 변경이 포함된 기능은 항상 다가오는 릴리스를 포함하는 master 브랜치로 보내야 합니다.

Compiled Assets​

laravel/laravel 저장소의 resources/css 또는 resources/js에 있는 대부분의 파일처럼 컴파일된 파일에 영향을 주는 변경 사항을 제출하는 경우, 컴파일된 파일은 커밋하지 마세요. 이러한 파일은 크기가 크기 때문에 관리자가 현실적으로 검토할 수 없습니다. 이 점은 Laravel에 악성 코드를 주입하는 방법으로 악용될 수 있습니다. 이를 방어적으로 방지하기 위해 모든 컴파일된 파일은 Laravel 관리자가 생성하고 커밋합니다.

AI-Generated Contributions​

Laravel에 제출되는 모든 풀 리퀘스트를 소중히 여깁니다. 그러나 사람의 신중한 검토와 판단 없이 주로 AI가 생성한 대규모 기여는 허용되지 않습니다.

프레임워크에 대한 규모가 크거나 복잡한 기여를 지원하기 위해 AI 도구를 사용하기로 했다면, 그 결과로 나온 코드를 제출하기 전에 직접 철저히 검토하고 테스트하며 이해해야 합니다.

pull request 설명은 반드시 기여자가 전부 직접 작성해야 합니다. AI가 생성한 설명이 포함된 pull request는 종료됩니다.

전적으로 AI로 생성된 이슈나 pull request를 대량으로 여는 행위는 용납되지 않습니다. 이러한 pull request는 검토 없이 닫히며, 기여한 사용자는 저장소에서 차단될 수 있습니다.

기여자들이 기존 코드베이스에 익숙해지고, 커뮤니티와 소통하며, 자신이 해결하려는 문제에 대한 이해와 신중한 고민이 반영된 pull request를 제출하기를 권장합니다.

Security Vulnerabilities​

Laravel에서 보안 취약점을 발견했다면 [email protected]으로 보안 팀에 이메일을 보내 주세요. 모든 보안 취약점은 신속하게 처리됩니다.

Coding Style​

Laravel은 PSR-2 코딩 표준과 PSR-4 오토로딩 표준을 따릅니다.

PHPDoc​

아래는 유효한 Laravel 문서 블록의 예시입니다. @param 속성 뒤에는 공백 두 칸, 인수 타입, 다시 공백 두 칸, 마지막으로 변수명이 온다는 점에 유의하세요.

/**
 * 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.
 * [tl! remove]
 * @return void [tl! remove]
 */
public function handle(AudioProcessor $processor): void
{
    // ...
}

하지만 네이티브 타입이 제네릭이라면 @param 또는 @return 속성을 사용해 제네릭 타입을 명시해 주세요.

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

StyleCI​

코드 스타일이 완벽하지 않아도 걱정하지 마세요! StyleCI는 pull request가 병합된 후 스타일 수정 사항을 Laravel 저장소에 자동으로 병합합니다. 이를 통해 우리는 코드 스타일이 아니라 기여 내용에 집중할 수 있습니다.

Code of Conduct​

Laravel 행동 강령은 Ruby 행동 강령에서 파생되었습니다. 행동 강령 위반 사항은 Taylor Otwell([email protected])에게 신고할 수 있습니다.

  • 참가자는 서로 다른 견해를 존중해야 합니다.
  • 참가자는 자신의 언어와 행동에 인신공격이나 상대를 폄하하는 개인적 발언이 포함되지 않도록 해야 합니다.
  • 다른 사람의 말과 행동을 해석할 때 참가자는 항상 선의의 의도를 전제로 해야 합니다.
  • 합리적으로 괴롭힘으로 간주할 수 있는 행동은 용납되지 않습니다.