프로젝트에 기여

GitHub에서 프로젝트에 기여하는 것은 공동 목표를 달성하기 위해 함께 작업하는 개발자와 공동 작업자에게 반드시 필요한 기술입니다. 버그를 수정하거나, 기능을 추가하거나, 문서를 개선하는 등 어떤 작업을 하든 기여하는 과정은 체계적이고 효율적인 협업을 가능하게 합니다.

리포지토리를 포크하고, 분기를 만들고, 끌어오기 요청을 제출하는 GitHub 흐름에 따르면, 다른 사용자의 작업을 방해하지 않고도 프로젝트에 변경 내용을 제안하고 피드백을 받을 수 있습니다.

이 가이드에서는 GitHub UI 및 명령줄을 사용하여 프로젝트에 기여하는 방법에 대한 안내를 제공합니다. GitHub Desktop을 이용한 기여 방법은 GitHub Desktop에서 리포지토리 복제 및 포크을(를) 참조하세요. GitHub CLI(명령줄 인터페이스)를 이용한 기여 방법은 GitHub CLI 빠른 시작을(를) 참조하세요.

포크 정보

다른 사람의 프로젝트에 기여하고 싶지만 직접 변경할 수 있는 권한이 없는 경우 프로젝트의 복사본을 직접 만들고, 업데이트를 만든 다음, 기본 프로젝트에 포함하도록 해당 업데이트를 제안할 수 있습니다. 이 프로세스를 “포크 및 끌어오기 요청” 워크플로라고도 합니다.

프로젝트의 고유한 복사본(또는 “포크”)을 만들 때 원래 프로젝트와 코드를 공유하는 새 작업 영역을 만드는 것과 같습니다. 이는 오픈 소스 프로젝트 또는 원래 프로젝트에 대한 쓰기 권한이 없는 경우에 유용합니다.

복사본에 변경 내용을 적용한 후 끌어오기 요청으로 제출할 수 있습니다. 이는 기본 프로젝트에 변경 내용을 다시 제안하는 방법입니다. 자세한 내용은 리포지토리 포크을(를) 참조하세요.

프로젝트의 고유한 복사본 만들기

이 자습서에서는 포크 및 끌어오기 요청 워크플로를 테스트할 수 있는 GitHub에서 호스트되는 테스트 리포지토리인 Spoon-Knife 프로젝트를 사용합니다.

1. https://github.com/octocat/Spoon-Knife에서 Spoon-Knife 프로젝트로 이동합니다.

2. 페이지의 오른쪽 상단에서 Fork(포크)를 클릭합니다.

   

3. "소유자"에서 드롭다운 메뉴를 선택하고 포크된 리포지토리의 소유자를 선택합니다.

   참고 항목

   사용자 이름이 회색으로 표시되면 포크가 이미 있기 때문입니다. 대신 기존 포크를 최신 상태로 유지해야 합니다. 자세한 내용은 포크 동기화을(를) 참조하세요.

4. 기본적으로 포크의 이름은 업스트림 리포지토리와 동일합니다. 필요에 따라 포크를 더 구분하려면, "리포지토리 이름" 필드에 이름을 입력합니다.

5. 필요에 따라 ‘설명’ 필드에 포크 설명을 입력합니다.

6. 필요에 따라 DEFAULT 분기만 복사를 선택합니다.

   오픈 소스 프로젝트에 기여하는 것과 같은 많은 포크 시나리오의 경우 기본 분기만 복사하면 됩니다. 이 옵션을 선택하지 않으면, 모든 분기가 새 포크로 복사됩니다.

7. 포크 만들기를 클릭합니다.

컴퓨터에 포크 복제

Spoon-Knife 리포지토리를 성공적으로 포크했지만, 지금까지는 포크가 GitHub에만 존재합니다. 프로젝트에서 사용하려면 이를 컴퓨터에 복제해야 합니다.

명령줄, GitHub CLI 또는 GitHub Desktop을 사용하여 포크를 복제할 수 있습니다.

1. GitHub에서 Spoon-Knife 리포지토리의 포크로 이동합니다.

2. 파일 목록 위에서 코드를 클릭합니다.

   

3. 리포지토리의 URL을 복사합니다.

   • HTTPS를 사용하여 리포지토리를 복제하려면 "HTTPS"에서 을 클릭합니다.

   • 조직의 SSH 인증 기관에서 발급한 인증서를 포함하여 SSH 키를 사용하여 리포지토리를 복제하려면 SSH를 클릭한 다음, 을 클릭합니다.

   • GitHub CLI를 사용하여 리포지토리를 복제하려면 GitHub CLI 를 클릭한 다음, 을 클릭합니다.

     

4. Mac 또는 Linux에서 터미널을 엽니다. Windows에서 Git Bash를 엽니다.

5. 현재 작업 디렉터리를 복제 대상 디렉터리의 위치로 변경합니다.

6. git clone을 입력한 다음 이전에 복사한 URL을 붙여넣습니다. 그러면 다음과 같이 되며, 여기서 YOUR-USERNAME 대신 GitHub 사용자 이름을 사용합니다.

   git clone https://github.com/YOUR-USERNAME/Spoon-Knife
   

7. Enter 키를 누릅니다. 로컬 복제본이 만들어집니다.

   $ git clone https://github.com/YOUR-USERNAME/Spoon-Knife
   > Cloning into `Spoon-Knife`...
   > remote: Counting objects: 10, done.
   > remote: Compressing objects: 100% (8/8), done.
   > remove: Total 10 (delta 1), reused 10 (delta 1)
   > Unpacking objects: 100% (10/10), done.
   

작업할 분기 만들기

프로젝트를 변경하기 전에 새 분기를 만들고 체크 아웃해야 합니다. 자체 분기의 변경 내용을 유지하여 GitHub 흐름을 따르고 나중에 동일한 프로젝트에 더 쉽게 기여할 수 있는지 확인합니다. GitHub 흐름을(를) 참조하세요.

git branch BRANCH-NAME
git checkout BRANCH-NAME

변경 내용 만들기 및 푸시

Visual Studio Code과(와) 같이 즐겨찾는 텍스트 편집기를 사용하여 프로젝트 내용을 몇 가지 변경합니다. 예를 들어 index.html에서 텍스트를 변경하여 GitHub 사용자 이름을 추가할 수 있습니다.

변경 내용을 제출할 준비가 되면 변경 내용을 스테이징하고 커밋합니다. git add .는 Git에 다음 커밋에 모든 변경 내용을 포함하도록 지시합니다. git commit은 변경 내용의 스냅샷을 만듭니다.

git add .
git commit -m "a short description of the change"

파일을 스테이징하고 커밋하면 Git에 “내 변경 사항의 스냅샷을 만들어 줘”라고 전달하는 셈입니다. 계속해서 더 많은 변경을 수행하고 더 많은 커밋 스냅샷을 만들 수 있습니다.

현재, 변경 내용은 로컬에만 존재합니다. GitHub까지 변경 내용을 푸시할 준비가 되면 변경 내용을 원격으로 푸시합니다.

git push

끌어오기 요청

끌어오기 요청을 만드는 것은 다른 사람의 프로젝트를 포크하는 마지막 단계입니다. 유익한 변경을 수행하고 원래 리포지토리에 제안하려는 경우, 유지 관리자가 검토할 수 있도록 끌어오기 요청을 만듭니다.

이렇게 하려면 프로젝트가 있는 GitHub의 리포지토리로 이동합니다. 이 예시에서는 이 리포지토리가 https://github.com/<your_username>/Spoon-Knife에 있습니다. octocat:main의 앞에 분기가 앞에 하나의 커밋임을 나타내는 배너가 표시됩니다. Contribute(기여), Open a pull request(끌어오기 요청 열기)를 클릭합니다.

GitHub를 통해 포크와 octocat/Spoon-Knife 리포지토리 간의 차이점을 보여 주는 페이지로 이동합니다. 끌어오기 요청 만들기를 클릭합니다.

GitHub를 통해 변경 내용에 대한 제목과 설명을 입력할 수 있는 페이지로 이동합니다. 처음에 이 끌어오기 요청을 만드는 이유에 대한 유용한 정보와 근거를 최대한 제공하는 것이 중요합니다. 변경 내용이 생각만큼 모든 사람에게 유용한지 프로젝트 소유자가 확인할 수 있어야 합니다. 마지막으로, Create pull request(끌어오기 요청 만들기)를 클릭합니다.

프로젝트 숙지

프로젝트를 처음 접하는 경우 Copilot을 사용하여 리포지토리의 목적을 이해하고, 파일을 검사하고, 특정 코드 줄을 자세히 살펴볼 수 있습니다. GitHub Copilot을 사용하여 프로젝트 탐색을(를) 참조하세요.