Skip to content
코드 리뷰

더 나은 코드 작성

GitHub에는 모든 pull request에 간단한 코드 검토 도구가 내장되어 있습니다. 팀이 코드 품질을 개선하고 워크플로에 잘 맞는 검토 프로세스를 만들 수 있습니다.

모든 변경은 pull request로 시작됩니다.

pull request를 여는 GitHub 인터페이스를 보여주는 이미지입니다. 기본 브랜치와 비교 브랜치를 선택할 수 있는 드롭다운 메뉴, 자동 병합 가능 여부를 나타내는 초록색 체크 표시, 주석을 입력할 수 있는 텍스트 상자, 서식 지정 옵션을 제공합니다.

모든 변경은 pull request로 시작됩니다.

  • pull request로 새로운 기능을 시작하거나 기존 코드의 변경 사항을 제안하세요. pull request는 팀이 세부 사항을 조율하고 변경 사항을 고치는 데 기초가 됩니다.
  • pull request는 팀이 GitHub에서 코드를 검토하고 개선하는 데 있어 기본적인 요소입니다. 소스 코드를 변경하기 전에, 프로젝트를 개선하고, 새로운 기능을 제안하며, 구현 세부 사항을 논의할 수 있습니다.

업데이트된 내용을 모두 보고
상황에 맞는 조치를 취합니다.

차이점

This image visually represents changes made to a stylesheet file, highlighting how the layout or design of a web page might be altered through these CSS adjustments.

코드의 컨텍스트에서 변경 사항을 미리 보면서 제안된 내용을 확인합니다. 원본 파일과의 차이점을 나란히 비교하는 이 보기에는 추가되거나 수정되거나 삭제된 코드가 강조 표시되므로 변경 사항을 쉽게 확인할 수 있습니다.

자세히 알아보기

기록

Screenshot of two commits added, and the changes were approved.

타임라인 스타일의 인터페이스에서 pull request와 관련한 커밋, 주석 및 참조를 탐색합니다. 또한 마지막으로 확인한 후에 변경된 내용이 pull request에 강조 표시됩니다.

자세히 알아보기

블레임

Image showing a file history showing four version entries with names and timestamps: 'First draft' and 'delete old pricing,' modified over the past few months.

특정 변경 사항을 적용하기 이전의 파일 상태를 확인합니다. 블레임 보기를 사용하면 파일의 전체 변경 기록을 보지 않고도 파일의 특정 부분이 시간에 따라 어떻게 변경되었는지 확인할 수 있습니다.

자세히 알아보기

코드 내에서
코드에 대해 논의

주석

GitHub에서는 코드 작성 중에 대화를 할 수 있습니다. 코드 구문에 자세한 주석을 남기고 구조에 대해 인라인으로 질문을 하세요.

The image shows a section of a user interface. At the top, there is a list with three items: "Line 10: Layouts" with a minus sign in red, "Line 11: Grid system" with a plus sign in green, and "Line 12: Layout are built on a 12 column grids." Below this list, there is a comment from the user "rajqflow" made 1 day ago that says, "Good cal, this is more specific!" The comment has received 5 thumbs-up likes and 2 heart reactions.

검토 요청

코드 작성한 입장이라면, 손쉽게 동료에게 코드 검토를 요청할 수 있습니다. pull request에 사용자를 추가하면 해당 사용자에게 피드백을 요청하는 알림이 전송됩니다.

The image shows a user interface for requesting a review. At the top, there is a text box with the placeholder "Request a review" and an input field below it containing the letter "o". Underneath the input field, there are two user suggestions: "kharyrizen Raymonda Khouri" with an avatar of a person, and "hankzolo Hank Zoeng" with an avatar of another person.

검토

팀원들에게 전송되는 알림을 줄여주세요. 주석을 하나의 일관된 검토로 묶은 후, 해당 주석이 필수적인 변경 사항인지 아니면 단순한 제안인지를 지정합니다.

The image displays a notification message. The notification features a red circle with a white 'X' icon and the title "Review required." Below the title, it states, "At least one approve review is required by reviewers to write access. Learn more." Additionally, there is an avatar of a person with the username "khayrizen" and text indicating that this user was requested for review.

충돌을 피할 수 없는 경우도 있습니다. 명령줄 없이 GitHub에서 간단한 병합 충돌을 해결하여 pull request를 더 빠르게 병합하세요.

자세히 알아보기
Alert indicating a branch conflict with files that need to be resolved before merging.

최고 품질의 코드 병합

검토를 통해 코드를 개선할 수 있지만, 실수는 발생하기 마련입니다. 세부적인 권한 설정과 상태 검사를 통해 사람의 실수를 줄이고, 고품질 코드만 병합되도록 보장합니다.

빠르고 연관성 높은 결과

리포지토리 설정을 통해 협력자에게 필요한 만큼의 액세스 권한을 부여합니다. 몇몇 팀으로 액세스 권한 부여 범위를 확장할 수 있으며, 파일을 읽거나 쓸 수 있도록 할 팀을 선택할 수 있습니다. 제공되는 권한 관련 옵션은 요금제에 따라 다릅니다.

요금제 옵션 보기

보호된 브랜치

보호된 브랜치는 코드의 무결성을 유지하는 데 유용합니다. 브랜치에 push할 수 있는 사용자를 제한하고, 특정 브랜치로의 강제 푸시를 비활성화합니다. 그런 다음 보호된 브랜치 API로 정책을 확장합니다.

자세히 알아보기

required status check

브랜치의 오류 방지를 위한 추가 보호 계층으로 required status check를 생성합니다. 상태 API를 사용하여 검사를 적용하고, 모든 검사를 통과할 때까지 병합 버튼을 비활성화합니다. 실수는 인간의 영역, 자동화는 신의 영역!

상태 API 문서

모든 변경은 pull request로 시작됩니다.

시작하기