티켓 분류

Django는 코드베이스 작업을 관리하기 위해 Trac_을 사용합니다. Trac은 커뮤니티가 가꾸는 정원으로, 사람들이 발견한 버그와 Django가 추가하기로 한 기능을 담고 있습니다. 여느 정원처럼, 때로는 뽑아야 할 잡초가 있고 수확해야 할 꽃과 채소도 있습니다. 이를 구분하기 위해 여러분의 도움이 필요하며, 결국 우리 모두가 그 혜택을 누리게 됩니다.

모든 정원이 그렇듯, 우리도 완벽을 추구하지만 현실에는 완벽한 정원이란 없습니다. 아무리 잘 가꾸어진 정원이라도 달팽이와 곤충은 늘 있기 마련입니다. 커뮤니티라는 정원에는 좋은 의도를 가졌음에도 실수로 잡초에 비료를 주거나 장미를 해치는 이들도 있습니다. 이러한 문제를 최소화하고 스스로 관리하며, 새로 합류한 사람들이 가치 있는 기여자로 성장할 수 있도록 돕는 것은 공동체 모두의 역할입니다.

마찬가지로, 우리는 Trac이 Django의 발전 상태를 완벽하게 표현하는 것을 목표로 하고 있지만, 우리는 이것이 일어나지 않을 것이라는 것을 인정합니다. Trac 유지보수의 부하를 커뮤니티에 분배함으로써 실수가 있을 것으로 받아들입니다. 트랙은 “대부분 정확”하며, 때때로 틀릴 수 있다는 사실에 대해 허용합니다. 괜찮아요. 우리는 마감일이 있는 완벽주의자입니다.

커뮤니티의 지속적인 참여를 바탕으로 운영됩니다. 티켓을 최대한 정확하게 유지하고, 혼란이나 의견 차이가 있을 때는 `Django Forum`_에서 이슈를 제기해 함께 논의해 주세요.

장고는 지역 사회 프로젝트이며, 모든 기여가 도움이 됩니다. 여러분 없이는 할 수 없습니다!

분류 워크플로우

안타깝게도 티켓 트래커의 모든 보고서가 필요한 :ref:`required details <reporting-bugs>`를 모두 포함하고 있는 것은 아닙니다. 많은 티켓에 해결 방안이 제안되지만, 이러한 방안이 :ref:`adhering to the guidelines for contributing <patch-style>`의 모든 요구 사항을 충족하는 것은 아닙니다.

도움이 되는 한 가지 방법은 다른 사용자가 만든 티켓을 *분류*하는 것입니다.

대부분의 워크플로는 티켓의 :ref:’triage stage’ 개념을 기반으로 한다. 각 단계는 주어진 티켓이 수명 동안 항상 어디에 있는지를 설명합니다. 이 속성은 소수의 플래그와 함께 각 티켓이 무엇을 기다리고 있는지, 누구를 기다리고 있는지 쉽게 알려줍니다.

한 장의 사진이 천 마디의 말보다 더 가치가 있으니, 거기서부터 시작합시다.

이 도표에는 네 가지 역할이 있습니다. 메인테이너(또는 펠로우)는 대개 모든 역할에 참여하지만, Django 커뮤니티에서는 누구나 머저를 제외한 모든 역할에 참여할 수 있습니다. :ref:`merger role <mergers-team>`은 :ref:`Steering Council <steering-council>`의 투표를 통해 부여됩니다.

• 분류자: 티켓이 실제 이슈를 설명하는지 확인하고 트래커를 정리하는 방식으로 누구나 이 역할을 맡을 수 있습니다.

• 버그 수정자: pull request를 열고 티켓에 대한 해결 방안을 작업하는 방식으로 누구나 기여할 수 있습니다.

• 검토자: 누구나 pull request를 검토하고 개선 사항을 제안할 수 있습니다.

• 머저: 커밋 권한이 있는 사람으로서, 변경 사항을 병합할지 여부를 최종적으로 결정합니다.

Trac 시스템은 의도적으로 공개되어 있어 누구나 티켓 작업을 통해 기여할 수 있습니다. Django는 커뮤니티 프로젝트이며, :ref:`triage and collaboration by the community <how-can-i-help-with-triaging>`를 장려합니다. 바로 여러분이 참여할 수 있습니다!

예를 들어 티켓의 일반적인 진행 과정은 다음과 같습니다.

• Alice가 티켓을 생성하고 미완성 pull request(테스트 누락, 잘못된 구현)를 엽니다.

• Bob은 pull request를 검토하고 티켓을 “Accepted”로 표시한 뒤, “needs tests”와 “patch needs improvement” 플래그를 설정하고 Alice가 패치를 개선할 수 있는 방법을 설명하는 코멘트를 남깁니다. 이로 인해 티켓은 자동으로 “accepted” 단계의 “waiting on author” 큐로 이동합니다.

• Alice는 pull request를 업데이트하고 테스트를 추가한 다음(구현은 아직 수정하지 않은 채), 플래그 두 개를 제거합니다. 티켓은 “needs PR review” 큐로 이동합니다.

• Charlie는 pull request를 검토하고 “patch needs improvement” 플래그를 다시 설정한 다음, 구현 변경을 제안하는 코멘트를 남깁니다. 티켓은 “waiting on author” 큐로 다시 이동합니다.

• Alice는 pull request를 다시 업데이트하고, 이번에는 구현을 수정한 뒤 “patch needs improvement” 플래그를 제거합니다. 티켓은 “needs PR review” 큐로 한 번 더 이동합니다.

• 데이지가 풀 요청을 검토하고 티켓을 “체크인 준비 완료”로 표시합니다.

• :ref:`merger <mergers-team>`인 Jacob이 pull request를 검토하고 병합합니다.

일부 티켓은 이러한 단계를 빠르게 거치지만, 시간과 논의가 더 많이 필요한 경우도 있습니다. 모든 기여는 Django를 개선하는 데 도움이 됩니다.

분류 단계

아래에서 우리는 티켓이 수명 동안 흐를 수 있는 다양한 단계를 더 자세히 설명합니다.

리뷰 되지 않음

이 티켓은 해당 티켓이 유효한 이슈를 포함하고 있는지, 또는 어떤 이유로 닫혀야 하는지를 판단할 수 있다고 생각한 사람이 아직 검토하지 않은 상태입니다. 검토되지 않은 티켓은 “triage” 큐에 표시됩니다.

검토되지 않은 티켓은 승인되기 전에 추가로 개선될 수 있습니다. 티켓 작성자이면서 패치를 제출할 의도가 있는 경우가 아니라면, 검토되지 않은 티켓은 :ref:`claimed <claiming-tickets>`해서는 안됩니다.

확인됨

“accepted”는 티켓에 설명된 이슈가 유효하고 해결 가능한 상태임을 의미합니다. 이는 세 가지 큐로 나뉩니다.

• 패치 필요 (Accepted + 플래그 없음)

  티켓은 유효하지만 아직 패치를 제출한 사람이 없습니다. 따라서 이 티켓에 대한 수정 작업을 시작해도 되는 경우가 많습니다. 이는 Accepted 상태의 기능보다 Accepted 상태의 버그에 더 해당되는 경우가 많습니다. Accepted 상태의 버그 티켓은 적어도 한 명의 분류자가 해당 이슈를 실제 버그로 확인했음을 의미하며, 가능하다면 수정하는 것이 좋습니다.

  새로운 기능의 경우, accepted 상태의 티켓은 아이디어가 적절한 :ref:`process for suggesting new features <requesting-features>`를 거치고, 커뮤니티와 :ref:`Steering Council <steering-council>`의 승인을 받거나 DEP에서 승인된 이후에만 존재해야 합니다.

• PR 검토 필요 (Accepted + 패치 있음)

  티켓은 제공된 패치에 대한 검토를 기다리고 있는 상태입니다. 즉, 솔루션을 다운로드하여 실행해 보고, 테스트와 문서가 포함되어 있는지 확인하고, 해당 패치를 적용한 상태에서 테스트 스위트를 실행한 후 티켓에 피드백을 남기는 단계입니다.

• 작성자 대기 중 (Accepted + 패치 있음 + 수정 필요)

  이는 티켓이 검토되었으며 추가 작업이 필요한 것으로 확인되었음을 의미합니다. “니즈 테스트” 및 “니즈 문서”는 스스로 설명할 수 있습니다. “패치 개선 필요”는 일반적으로 코드 개선을 위해 무엇이 필요한지 설명하는 티켓에 대한 코멘트와 함께 제공됩니다.

체크인 준비

이 티켓은 패치를 제공한 사람을 제외한 다른 커뮤니티 구성원이 검토하여, 커밋 가능한 상태에 필요한 모든 요구 사항을 충족하는 것으로 확인되었습니다. 이제 커밋되기 전에 :ref:`merger <mergers-team>`의 최종 검토가 필요합니다.

풀 요청이 많아요. 패치를 검토하는 데 시간이 걸릴 수 있습니다. 여기서 몇 가지 아이디어를 얻으려면:ref:’코드 기여 FAQ’를 참조하십시오.

언젠가/어쩌면

이 단계는 도표에 나와 있지 않습니다. 장기적인 변경 사항을 추적하기 위해 제한적으로 사용됩니다.

이러한 티켓은 흔하지 않으며, 구체적이고 실행 가능한 이슈를 설명하지 않기 때문에 전반적으로 활용도가 낮습니다.

기타 분류 속성

트랙에 확인란으로 나타나는 여러 플래그를 티켓에 설정할 수 있습니다.

패치 있음

이는 해당 티켓에 해결 방안이 제안되어 있음을 의미합니다. 이러한 방안은 :ref:`documented guidelines <patch-review-checklist>`를 준수하는 지 확인하기 위해 검토됩니다.

다음 세 가지 필드(문서 필요, 테스트 필요, 패치 개선 필요)는 패치가 제공된 경우에만 적용됩니다.

문서 필요

이 플래그는 관련 문서가 필요한 패치가 있는 티켓에 사용됩니다. 기능을 코드베이스에 체크인하려면 기능에 대한 완전한 문서화가 선행되어야 합니다.

테스트 필요

이 플래그는 해당 패치에 단위 테스트가 필요함을 나타냅니다. 앞서 언급했듯이, 단위 테스트는 유효한 기여를 위해 반드시 포함되어야 합니다.

패치 개선 필요

이 플래그는 티켓에 해결책이 있더라도, 아직 최종 반영할 준비가 되지 않았음을 의미합니다. 패치가 최신 코드와 충돌하거나, 구현 방식에 결함이 있거나, 코드가 Django의 표준을 충족하지 못하는 경우 등이 이에 해당할 수 있습니다.

손쉬운 선택

티켓은 작고 쉬운 변경을 요구합니다.

타입

티켓은 *유형*별로 다음 중 하나로 분류해야 할 항목은 다음과 같습니다.

• 새 기능

  새로운 걸 추가해줘서.

• 버그

  기존 물체가 고장났거나 예상대로 작동하지 않을 때를 위한 것입니다.

• 정리/최적화

  아무것도 망가진 것이 없지만 무언가가 더 깨끗하고, 더 좋고, 더 빠르고, 더 강하게 만들 수 있을 때 말입니다.

요소

티켓은 Django 코드베이스의 어느 영역에 속하는지를 나타내는 *components*로 분류되어야 합니다. 이것은 표를 더 잘 정리하고 더 쉽게 찾을 수 있게 해줍니다.

심각도

severity 속성은 다음 Django 버전 릴리스 전에 반드시 해결되어야 하는 차단 이슈를 식별하는 데 사용됩니다. 이러한 문제는 일반적으로 이전 버전에서 회귀를 일으키거나 심각한 데이터 손실을 초래할 수 있는 버그입니다. 이 속성은 거의 사용되지 않으며, 대부분의 티켓은 “Normal” 수준의 심각도를 가집니다.

버전

version 속성은 버그가 처음 재현된 버전을 나타냅니다. 티켓 분류 과정에서 이 필드는 업데이트될 수 있지만, 해당 버전이 지원 종료된 이후에는 추가로 업데이트할 필요는 없습니다. 문제가 여전히 존재함을 나타내기 위해 이 필드를 “dev”로 재설정해서는 안 되며, 대신 테스트한 커밋 해시를 코멘트에 남기면 됩니다.

UI/UX

이 플래그는 사용자 인터페이스 및 사용자 경험 질문과 관련된 티켓에 사용됩니다. 예를 들어 이 플래그는 양식 또는 관리 인터페이스의 사용자 대면 기능에 적합합니다.

Cc

이 필드에 사용자 이름 또는 전자 메일 주소를 추가하여 티켓에 대한 새로운 기여가 있을 때 알림을 받을 수 있습니다.

키워드

이 필드를 사용하면 여러 키워드로 티켓에 레이블을 지정할 수 있습니다. 예를 들어 동일한 주제의 여러 티켓을 그룹화할 때 유용합니다. 키워드는 쉼표나 공백으로 구분해 입력할 수 있습니다. 키워드 검색 시에는 해당 문자열이 포함된 키워드를 모두 찾아냅니다. 예를 들어 “form” 키워드가 있는 티켓을 클릭하면 “formset”, “modelformset”, “ManagementForm”과 같은 문자열이 포함된 키워드로 태그된 유사한 티켓이 표시됩니다.

티켓 종료

티켓이 유용한 수명 주기를 마치면 닫힐 시간입니다. 하지만 표를 닫는 것은 큰 책임입니다. 문제가 정말로 해결되었는지 확인해야 하며, 티켓의 리포터가 티켓이 닫히는 것을 달가워하지 않을 수도 있다는 것을 명심해야 합니다. 티켓을 닫아야 할지 잘 모르겠으면 대신 자신의 생각을 댓글로 남겨주세요.

티켓을 닫는 경우 항상 다음 사항을 확인해야 합니다.

• 문제가 해결되었는지 확인하십시오.

• 티켓 마감 결정을 설명하는 댓글을 남겨주세요.

• 그들이 티켓을 개선해서 다시 열 수 있는 방법이 있다면, 그들에게 알려주십시오.

• 티켓이 중복된 경우 원래 티켓을 참조하십시오. 또한 원래 티켓에 설명을 남겨 닫힌 티켓을 상호 참조합니다. 이렇게 하면 보고된 버그 또는 요청된 기능에 대한 더 많은 관련 정보에 액세스할 수 있습니다.

• 예의를 지키세요. 아무도 그들의 티켓이 닫히는 것을 좋아하지 않습니다. 그것은 좌절감을 주거나 심지어 낙담시킬 수 있습니다. 사람들이 장고에 기여하는 것을 꺼리는 것을 피하는 가장 좋은 방법은 예의 바르고 친근하게 대하는 것이고 그들이 앞으로 이 티켓과 다른 티켓들을 개선할 수 있는 방법에 대한 제안을 하는 것입니다.

티켓은 여러 가지 방법으로 해결할 수 있습니다.

• 고정됨

  Django에 패치가 롤업되고 문제가 해결된 후 사용됩니다.

• 무효함

  티켓이 잘못된 것으로 확인될 때 사용됩니다. 즉, 티켓의 문제는 실제로 사용자 오류의 결과이거나, 장고가 아닌 다른 문제의 문제를 설명하거나, 버그 보고서나 기능 요청이 아닙니다(예: 일부 새 사용자는 티켓으로 지원 쿼리를 제출합니다).

• 고쳐지지 않다

  Django에서 수용하기 적절하지 않다고 판단되는 요청은 이 상태로 표시합니다. 티켓을 닫은 사람이 제시한 근거에 이견이 있는 경우, 보고자에게 `Django Forum`_에서 논의를 시작해 달라고 요청하며 “wontfix”로 닫히기도 합니다. 반대로 충분한 사전 논의를 거친 후 티켓을 닫는 경우도 있습니다. “wontfix”로 닫힌 티켓을 다시 열기 전에는 반드시 포럼을 통해 합의를 얻어야 합니다.

• needsnewfeatureprocess

  티켓이 새로운 기능이 필요한 경우 이 상태로 표시합니다. 이러한 기능은 커뮤니티의 의견과 지지를 필요로 합니다. :ref:`process for suggesting new features <requesting-features>`를 참고하세요.

• 복사하다, 사본을 만들다

  다른 티켓이 동일한 문제를 다룰 때 사용됩니다. 중복된 티켓을 닫음으로써, 우리는 모든 논의를 한 곳에 보관하고, 이것은 모두에게 도움이 됩니다.

• 나를 위해 일하다

  티켓에 원래 버그를 복제하기에 충분한 세부 정보가 없을 때 사용됩니다.

• 정보가 필요하다.

  티켓에 보고된 문제를 복제하기에 충분한 정보가 포함되어 있지 않지만 잠재적으로 유효한 경우에 사용됩니다. 더 많은 정보가 제공되면 티켓을 다시 열어야 합니다.

티켓이 잘못 닫혔다고 생각되는 경우, 예를 들어 여전히 문제가 발생하고 있거나 다른 곳에서 문제가 다시 나타났거나 분류자가 실수를 했다고 판단된다면 티켓을 다시 열고 추가 정보를 제공해 주세요. 다시 한 번 말하지만, “wontfix” 또는 “needsnewfeatureprocess”로 표시된 티켓은 다시 열지 마세요. “wontfix” 티켓의 경우에는 Django Forum`_에서 문제를 제기해 주세요. “needsnewfeatureprocess” 티켓의 경우에는 :ref:`new features process <requesting-features>.를 통해 기능을 제안해주세요.

개발에 어떻게 기여할 수 있을까요?

개발 과정은 주로 커뮤니티 구성원들이 이끌어갑니다. 정말로, 누구나 기여할 수 있습니다.

참여하려면 “Trac에서 계정 만들기”부터 시작하십시오. 계정이 있지만 암호를 잊어버린 경우 ‘비밀번호 재설정 페이지’를 사용하여 재설정할 수 있습니다.

그러면 다음을 통해 도움을 받을 수 있습니다.

• “Unreviewed” 상태의 티켓을 “invalid”, “worksforme”, “duplicate”, “wontfix” 또는 “needsnewfeatureprocess”로 닫습니다.

• 설명이 부족하여 처리가 어려운 경우 “Unreviewed” 상태의 티켓을 “needsinfo”로 닫습니다.

• 티켓이 잘못 설정된 티켓에 대해 “테스트 필요”, “문서 필요” 또는 “패치 있음” 플래그를 수정합니다.

• 크기가 작고 비교적 간단한 티켓에 ‘쉬운 픽킹’_ 플래그를 설정합니다.

• 아직 분류되지 않은 티켓의 *유형*을 설정합니다.

• 이전 티켓이 여전히 유효한지 확인하는 중입니다. 티켓이 오랫동안 활동을 하지 않은 경우 문제는 해결되었지만 티켓이 아직 닫히지 않았을 수 있습니다.

• 티켓에서 나타나는 추세와 테마를 파악합니다. Django의 특정 부분에 대한 버그 보고가 많다면 해당 코드 영역의 리팩터링을 고려해야 할 수 있습니다. 이러한 추세가 나타나면 관련 티켓을 참고하여 `Django Forum`_에 논의로 제기하세요.

• 다른 사람이 제출한 솔루션이 올바른지 확인합니다. 올바르고 문서와 테스트가 적절하다면 “Ready for Checkin” 단계로 이동합니다. 올바르지 않은 경우에는 댓글을 남겨 그 이유를 설명하고 해당 플래그(“Patch needs improvement”, “Needs tests” 등)를 설정합니다.

참고

‘Reports page’_에는 앞서 설명한 것처럼 티켓을 분류하고 제안을 검토하는 데 유용한 여러 Trac 쿼리 링크가 있습니다.

:doc:`/internals/contributing/new-contributors`에서도 자세한 내용을 확인할 수 있습니다.

그러나 티켓 데이터베이스에서 작업하는 모든 일반 커뮤니티 구성원에게 다음 사항을 요청합니다.

• Please don’t promote your own tickets to “Accepted”. Another community member should review the report and set this stage after reproducing and confirming the issue.

• 자신의 티켓을 “Ready for checkin”으로 올리지 마세요. 다른 사람의 티켓은 검토 후 “Ready for checkin”으로 표시할 수 있지만, 자신이 제출한 패치는 최소 한 명 이상의 커뮤니티 구성원이 검토해야 합니다.

• `Django Forum`_에 메시지를 게시해 합의를 구하기 전에는 결정을 번복하지 마세요.

• 변경이 필요한지 확신이 없다면 변경하지 말고, 티켓에 우려 사항을 남기거나 `Django Forum`_에 메시지를 게시하세요. 확신이 없어도 괜찮습니다. 여러분의 의견은 여전히 중요합니다.

회귀 분석 이등분

회귀는 일부 새로운 버전의 장고에는 있지만 이전 버전에는 없는 버그입니다. 매우 유용한 정보는 회귀 분석을 도입한 커밋입니다. 행동의 변화를 일으킨 커밋을 알면 변경이 의도적인 것인지 또는 의도하지 않은 부작용인지를 식별하는 데 도움이 됩니다. 이것을 결정하는 방법은 다음과 같습니다.

먼저 해당 문제에 대한 회귀 테스트를 Django의 테스트 스위트에 작성하세요. 예를 들어, 여기서는 마이그레이션에서 발생한 회귀 문제를 디버깅한다고 가정합니다. 테스트를 작성한 뒤 최신 main 브랜치에서 실패하는지 확인한 다음, 단독으로 실행할 수 있도록 별도의 파일로 분리하세요. 이 예시에서는 ``tests/migrations/test_regression.py``를 만들었다고 가정하며, 다음과 같이 실행할 수 있습니다.

$ ./runtests.py migrations.test_regression

다음으로, 테스트가 실패하기 때문에 현재 시점을 “bad”로 표시합니다.

$ git bisect bad
You need to start by "git bisect start"
Do you want me to do it for you [Y/n]? y

이제 회귀 문제가 도입되기 이전의 git 이력 상 시점(즉, 테스트가 통과하는 지점)을 찾아야 합니다. git checkout HEAD~100``과 같은 명령을 사용해 이전 리비전(이 경우 100 커밋 이전)으로 체크아웃합니다. 테스트가 실패하는지 확인하세요. 실패한다면 해당 시점을 "bad"(``git bisect bad)로 표시하고, 더 이전 리비전으로 이동해 다시 확인합니다. 테스트가 통과하는 리비전을 찾으면 “good”으로 표시합니다.

$ git bisect good
Bisecting: X revisions left to test after this (roughly Y steps)
...

이제 재미있는 부분입니다. ``git bisect run``을 사용하여 나머지 과정을 자동화할 수 있습니다.

$ git bisect run tests/runtests.py migrations.test_regression

테스트가 실패한 첫 번째 “나쁜” 커밋을 찾을 때까지 좋은 커밋과 나쁜 커밋 사이의 리비전을 자동으로 체크하려면 “git bisect”를 사용하여 이진 검색을 사용해야 합니다.

이제 Trac 티켓에 결과를 보고하고, 회귀 테스트를 첨부 파일로 포함시켜 주세요. 누군가가 버그에 대한 수정 사항을 작성할 때, 그들은 이미 당신의 테스트를 시작점으로 가지고 있을 것이다.