연습 - 첫 번째 끌어오기 요청 만들기

  • 6분

끌어오기 요청 템플릿 또는 CONTRIBUTING 파일에 지침이 있는 경우에 PR(끌어오기 요청)을 만드는 방법을 살펴보았습니다. 하지만 프로젝트에 규칙에 대한 설명서와 지침이 제공되지 않는 경우에는 어떻게 해야 하나요?

변경 내용 설명

좋은 커밋 메시지를 작성하고 이후에 끌어오기 요청을 작성하려면 다음 방법을 따르세요.

  • Git 커밋 메시지 제목 줄에서 다음 문장을 완성해야 합니다.
    • 해당하는 경우 이 커밋 <your subject line here>.
  • 현재 시제 명령어를 사용하여 변경에 대한 간략한 설명을 포함합니다. 예를 들어 ‘추가했습니다’ 또는 ‘추가합니다’ 대신 ‘추가하세요’를 사용합니다.
  • 제목 줄을 50자로 제한합니다.
  • 대문자로 시작하고, 마침표(.)로 끝나지 않습니다.
  • 제목 줄에서 이모지 또는 @mention 다른 GitHub 사용자를 사용할 수 있지만, 모든 프로젝트가 이를 허용하거나 권장하는 것은 아닙니다.

메시지 본문 및 끌어오기 요청의 경우 현재 시제를 계속 사용합니다. 변경의 동기를 포함해야 합니다. 변경 내용을 이전 동작과 대조합니다. 사용할 수 있는 공간을 사용하여 '대상' 및 '이유'를 '방법'과 비교하여 설명합니다.

커밋 메시지는 제출하려는 내용만큼 간단명료해야 합니다. 검토를 위해 소량의 격리된 변경 내용 세트를 커밋하거나 제출합니다. 이렇게 하면 변경 내용이 프로젝트에 병합될 가능성이 높아집니다.

세분성 추가

끌어오기 요청을 제출하기 전에 사이드바에서 PR을 완료하는 방법을 확인합니다. 프로젝트의 팀 구조를 잘 알고 있는 경우 ‘검토자’ 및/또는 ‘담당자’를 선택합니다. 예를 들어 CONTRIBUTING.md 파일에 사용 레이블이 있는 경우 ‘레이블’을 추가합니다. 레이블을 수행하려는 작업에 대한 시각적 단서로 사용할 수 있습니다. 유지 관리자가 하나 이상의 레이블을 추가할 수도 있습니다.

팁 (조언)

리포지토리에 CONTRIBUTING.md 파일 또는 PR 템플릿이 있는 경우 끌어오기 요청을 채울 때 지침을 따릅니다.

이 학습 모듈의 리포지토리에 사용되는 레이블은 다음과 같습니다.

  • 버그 (빨간색): 작동하지 않는 항목
  • 설명서 (파란색): 설명서 개선 또는 추가
  • 중복 (회색): 이 문제 또는 끌어오기 요청이 이미 있습니다.
  • 향상된 기능 (청록색): 새 기능 또는 요청

필요에 따라 사이드바에 ‘문제를 연결’할 수 있습니다. 그러면 끌어오기 요청을 성공적으로 병합하여 해당 문제를 닫을 수도 있습니다. 스레드의 알림에 대한 구독을 사용자 지정할 수도 있습니다 . 일부 PR은 많은 댓글과 리뷰 및 CI/CD 관련 알림을 받습니다. 다음 중 하나를 선택할 수 있습니다.

  • 구독하지 않음: 참여했거나 @mentioned에 해당한 경우에만 알림을 받습니다.
  • 가입: 이 끌어오기 요청에 대한 모든 알림 받기
  • 관습: 선택한 이벤트에 대해서만 알림을 받습니다.

연습

첫 번째 기여 프로젝트를 사용하여 끌어오기 요청을 포크, 복제 및 제출하는 방법을 연습합니다. 첫 번째 기여 프로젝트는 “초보자에게 첫 번째 기여를 만드는 방법을 안내”하는 것을 목표로 합니다. 명령줄과 일부 GUI(그래픽 사용자 인터페이스)를 사용하는 방법에 대한 가이드가 있습니다. 또한 이 프로젝트는 여러 언어를 지원합니다. Translations 폴더를 확인해야 합니다.

이전 단원에서 배운 내용과 여기 나온 내용을 염두에 두고 최근에 열었던 끌어오기 요청으로 돌아갑니다. 또는 감시 중인 프로젝트의 끌어오기 요청 탭으로 이동할 수 있습니다. 좋은 제목 줄이 어떻게 모든 차이를 만들 수 있는지 확인합니다. 끌어오기 요청을 적절히 업데이트하는 것이 좋습니다. 프로젝트를 변경하는 데 들인 것만큼 많은 시간을 PR 작성에 소요합니다. 이러한 노력은 유지 관리자가 커뮤니티 기여를 범주화하고 우선 순위를 지정(심사)하는 데 도움을 줍니다.

보너스: Microsoft의 접근성 지침 및 요구 사항을 확인합니다. 특히 기여에서 장애를 차별하는 언어를 방지하기 위해 UI와의 상호 작용을 설명하는 방법에 대한 정보를 참조하세요. 고객은 다양한 입력 방법을 사용하여 제품과 상호 작용합니다. 예를 들어 키보드, 마우스, 터치, 음성 등을 사용할 수 있습니다. 모든 입력 메서드를 사용하는 일반적인 동사를 사용하는 것이 좋습니다. 예를 들어 입력에 특정한 ‘클릭’이나 ‘살짝 밀기’ 대신 ‘선택’을 사용합니다.