이슈 트리아지¶
모든 일이 원활하게 진행되도록 이슈 추적기의 모든 이슈를 트리아지해야 합니다. 이 섹션에서는 트리아지에 어떤 작업이 포함되는지 설명합니다.
트리아지 체크리스트¶
처음 올라온 메시지와 댓글을 읽으십시오.
추적기를 검색하여 이슈가 중복이 아닌지 확인하십시오. 중복이라면 GitHub의 Close as duplicate 옵션을 사용하고 원래 이슈를 선택하십시오.
제목이 적당히 간결한지 확인하십시오. 동시에 이슈 목록을 훑어보는 사람이 주제를 빠르게 파악할 수 있을 만큼 구체적인 내용도 담겨 있어야 합니다.
풀 리퀘스트의 경우 제목 앞에 해당 이슈 번호가 붙어 있는지 확인하십시오(
gh-NNNNN: Title).관련된 레이블을 모두 설정하십시오.
적절한 경우 Assignees, Reviewers, Project 필드를 설정하고, 필요하면 관련된 사람을 @멘션하십시오.
다음에 필요한 조치를 제안하는 짧은 댓글을 남길 수도 있습니다. 메시지 목록이 길다면 요약이 큰 도움이 될 수 있습니다.
이슈가 명백히 유효하지 않다면(CPython과 무관한 내용, 스팸 등) GitHub의 Close as not planned 옵션을 사용하고 invalid 레이블을 적용할 수 있습니다.
이슈 필드¶
이 필드들은 이슈와 풀 리퀘스트의 사이드바에서 설정할 수 있습니다.
레이블¶
레이블은 이슈를 분류하고 풀 리퀘스트에 대한 특정 작업을 자동화하는 주요 수단입니다. 해당하는 레이블을 모두 설정하십시오. 자세한 내용은 GitHub 레이블를 참조하십시오.
담당자¶
이 필드는 이슈 해결을 위한 다음 단계를 누가 맡을 것으로 예상되는지 나타냅니다.
어떤 사람의 도움 없이는 이슈가 진행될 수 없다면 그 사람에게 이슈를 할당해도 됩니다. 예를 들어 진행 방법에 관한 기술적 결정을 그 사람이 내려야 하는 경우가 이에 해당합니다. 또한 특정 표준 라이브러리 모듈은 항상 특정인에게 할당해야 하므로 전문가 색인도 참고하십시오.
어떤 사람에게 이슈를 할당하려면 그 사람이 저장소에서 최소한 트리아지 권한을 반드시 가지고 있어야 한다는 점에 유의하십시오.
리뷰어¶
이 필드는 특정인에게 리뷰를 요청할 때 사용합니다.
대부분의 경우 따로 할 일은 없습니다. .github/CODEOWNERS 파일에 등록된 메인테이너에게는 자신이 관리하는 파일을 변경하는 풀 리퀘스트의 리뷰가 자동으로 요청되기 때문입니다. 그렇지 않은 경우 전문가 색인를 참고하여 영향을 받는 영역이나 플랫폼에 실무 지식이 있는 사람을 찾으십시오.
염두에 둔 사람이 Reviewers 드롭다운에 나타나지 않는다면(보통 저장소에서 필요한 권한이 없기 때문입니다) 대신 댓글에서 그 사람을 @멘션하십시오.
프로젝트¶
GitHub 프로젝트는 이슈와 풀 리퀘스트 전반에 걸쳐 특정 모듈, 플랫폼 또는 관심 분야의 작업을 추적하는 데 사용됩니다. 관련된 프로젝트를 모두 추가하십시오. 해당 레이블을 추가하면 일부 프로젝트는 자동으로 추가된다는 점에 유의하십시오.
이슈 트리아지 돕기¶
Python 소스 파일의 구조를 잘 파악하고 워크플로에 익숙해졌다면, 이슈 트리아지를 돕는 것은 기여하기에 아주 좋은 방법입니다. 다만 트리아지를 효과적으로 도우려면 Python 관련 작업 경험이 필요하다는 점을 알아 두십시오.
보고 분류하기¶
버그의 경우 이슈는 다음을 충족해야 합니다:
버그를 재현할 수 있도록 명확하게 설명해야 합니다
관련된 모든 플랫폼 세부 정보를 포함해야 합니다
버그의 영향을 받는 Python 버전을 명시합니다.
Python 개발 경험이 생기면 다음과 같은 일을 도울 수 있습니다:
버그를 재현해 보십시오: 여러분이 재현할 수 있을 만큼 명확하게 설명되어 있지 않다면, 코어 팀 구성원도 재현하지 못할 가능성이 큽니다.
다른 Python 버전에서도 이슈가 발생하는지 확인합니다: 버그가 개발 중인 Python 버전에만 영향을 미치는지, 아니면 유지 보수 상태인 다른 버전에도 영향을 미치는지 알면 언제나 도움이 됩니다.
단위 테스트를 작성합니다: 버그에 Python 테스트 스위트에 포함되어야 할 단위 테스트가 없다면, 그 테스트를 작성해 두는 것이 큰 도움이 될 수 있습니다.
이 모든 작업은 트리아지 팀 구성원이 이슈를 올바르게 분류하여 적합한 코어 팀 구성원이 적시에 처리할 수 있게 해 주므로 도움이 됩니다.
풀 리퀘스트 리뷰하기¶
이슈에 아직 리뷰되지 않은 풀 리퀘스트가 연결되어 있다면, 해당 풀 리퀘스트가 다음을 충족하는지 확인하여 도울 수 있습니다:
해결하려는 문제에 대한 좋은 해결책이어야 합니다
적절한 테스트를 포함해야 합니다
적절한 문서 변경 사항을 포함해야 합니다
(필요한 경우) NEWS 항목을 포함해야 합니다
main브랜치와 충돌이 없어야 합니다
이 모든 작업을 해 두면 코어 팀 구성원과 트리아지 담당자가 Python 코드베이스에 대한 작업 경험이 풍부한 사람만 알아챌 수 있는 미묘한 문제를 더 빠르게 살펴볼 수 있습니다.
풀 리퀘스트 수락하기도 참조하십시오.
도울 수 있는 이슈 찾기¶
트리아지를 돕고 싶다면, 실무 지식이 있는 모듈의 이슈를 검색해 보는 것도 좋습니다. 자세한 내용은 이슈 검색하기를 참조하십시오.