티켓 분류

Django uses Trac for managing the work on the code base. Trac is a community-tended garden of the bugs people have found and the features people would like to see added. As in any garden, sometimes there are weeds to be pulled and sometimes there are flowers and vegetables that need picking. We need your help to sort out one from the other, and in the end, we all benefit together.

Like all gardens, we can aspire to perfection, but in reality there’s no such thing. Even in the most pristine garden there are still snails and insects. In a community garden there are also helpful people who – with the best of intentions – fertilize the weeds and poison the roses. It’s the job of the community as a whole to self-manage, keep the problems to a minimum, and educate those coming into the community so that they can become valuable contributing members.

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

우리는 커뮤니티가 계속해서 참여하고, 티켓을 최대한 정확하게 보관하며, 혼란스럽거나 의견이 일치하지 않을 때 우리의 메일링 리스트에 대한 논의를 위해 문제를 제기하는 것에 의존합니다.

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

분류 워크플로우

안타깝게도 티켓 트래커의 모든 버그 보고서와 기능 요청이 모든 :doc:’필수 세부 정보’를 제공하는 것은 아닙니다. 많은 티켓에 패치가 있지만 이러한 패치는 a:ref:’good patch’의 모든 요구 사항을 충족하지 않습니다.

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

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

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

이 다이어그램에는 두 가지 역할이 있습니다.

• 병합: 커밋 액세스 권한이 있는 사람이 패치를 병합하는 최종 결정을 내릴 수 있습니다.
• 티켓트리거: 장고의 개발 과정에 참여하기로 선택한 장고 커뮤니티의 모든 사람입니다. 우리의 트랙 설치는 의도적으로 대중에게 개방되어 있으며, 누구나 티켓을 분류할 수 있습니다. 장고는 지역 사회 프로젝트이며, 우리는 다음과 같이 권장합니다:참조: “공동체에 의한 분류”.

예를 들어, 여기에서는 평균 티켓의 라이프사이클을 볼 수 있습니다.

• Alice가 티켓을 만들고 불완전한 풀 요청(테스트 없음, 잘못된 구현)을 보냅니다.
• 밥은 풀 요청을 검토하고 티켓을 “승인됨”, “테스트 필요”, “패치 개선 필요”로 표시하고 앨리스에게 패치를 개선할 수 있는 방법을 알려주는 댓글을 남깁니다.
• Alice는 풀 요청을 업데이트하고 테스트를 추가합니다(실행을 변경하지 않음). 그녀는 두 개의 플래그를 제거합니다.
• Charlie는 풀 요청을 검토하고 “패치 개선 필요” 플래그를 구현 개선에 대한 다른 설명과 함께 재설정합니다.
• 앨리스는 풀 요청을 업데이트하여 구현을 수정합니다. 그녀는 “패치 개선 필요” 플래그를 제거합니다.
• 데이지가 풀 요청을 검토하고 티켓을 “체크인 준비 완료”로 표시합니다.
• 제이콥(a :ref:’merge’)은 풀 요청을 검토하고 병합합니다.

어떤 티켓은 이보다 훨씬 적은 피드백을 요구하지만, 어떤 티켓은 훨씬 더 많은 피드백을 요구합니다.

분류 단계

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

리뷰 되지 않음

티켓이 유효한 이슈, 실행 가능한 기능을 포함하는지 또는 여러 가지 이유로 닫아야 하는지에 대해 판단할 자격이 있다고 생각하는 사람은 티켓을 검토하지 않았습니다.

확인됨

큰 회색 부분! “승인됨”의 절대적인 의미는 티켓에 설명된 문제가 유효하며 작업 단계에 있다는 것입니다. 그 외에도 몇 가지 고려 사항이 있습니다.

• 승인 + 플래그 없음

  티켓은 유효하지만 아직 패치를 제출한 사람이 없습니다. 이것은 종종 당신이 안전하게 그것에 대한 패치 작성을 시작할 수 있다는 것을 의미합니다. 이것은 일반적으로 허용되는 기능보다 허용되는 버그의 경우에 더 해당됩니다. 승인된 버그에 대한 티켓은 문제가 적어도 한 명의 트라이거에 의해 합법적인 버그로 확인되었음을 의미하며 가능하면 수정해야 합니다. 승인된 새 기능은 한 분류자가 해당 기능을 갖는 것이 좋다고 생각했다는 것을 의미할 수 있지만, 이것만으로는 합의된 견해를 나타내거나 패치가 해당 기능에 대해 허용된다는 것을 암시하지 않습니다. 의문 사항이 있는 경우 광범위한 패치를 작성하기 전에 더 많은 의견을 구하십시오.

• 승인됨 + 패치 있음

  티켓이 제공된 패치를 검토하는 사람들을 기다리고 있습니다. 즉, 패치를 다운로드하여 사용해보고, 테스트와 문서가 포함되어 있는지 확인하고, 포함된 패치로 테스트 제품군을 실행하고, 티켓에 피드백을 남깁니다.

• 승인 + 패치 + 니즈…

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

체크인 준비

이 티켓은 패치를 제공한 사람 이외의 커뮤니티 구성원이 검토한 결과 커밋 준비 패치에 대한 모든 요구 사항을 충족하는 것으로 나타났습니다. A:ref:”merge”는 이제 커밋하기 전에 패치를 최종 검토해야 합니다.

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

언젠가/어쩌면

This stage isn’t shown on the diagram. It’s used sparingly to keep track of high-level ideas or long-term feature requests.

이러한 티켓은 구체적인 실행 가능한 문제를 설명하지 않기 때문에 일반적이지 않고 전체적으로 덜 유용합니다. 이는 우수한 패치가 제출될 경우 언젠가 프레임워크에 추가하는 것을 고려할 수 있는 개선 요청입니다. 그들은 높은 우선순위가 아닙니다.

기타 분류 속성

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

패치 있음

즉, 티켓에 연결된 :doc:’patch<writing-code/submitting-patches>가 있음을 의미합니다. 패치가 “좋음”인지 확인하기 위해 이 패치가 검토됩니다.

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

문서 필요

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

테스트 필요

이 경우 패치에 관련 장치 테스트가 필요하다고 플래그가 지정됩니다. 이것은 유효한 패치의 필수 부분입니다.

패치 개선 필요

이 플래그는 티켓에 패치가 *있음*에도 불구하고 체크인 준비가 아직 되지 않았음을 의미합니다. 이는 패치가 더 이상 제대로 적용되지 않거나, 구현에 결함이 있거나, 코드가 당사의 표준을 충족하지 못한다는 것을 의미할 수 있습니다.

손쉬운 선택

작고 쉬운 패치가 필요한 티켓입니다.

타입

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

• 새 기능

  새로운 걸 추가해줘서.

• 버그

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

• 정리/최적화

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

요소

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

심각도

The severity attribute is used to identify blockers, that is, issues that should get fixed before releasing the next version of Django. Typically those issues are bugs causing regressions from earlier versions or potentially causing severe data losses. This attribute is quite rarely used and the vast majority of tickets have a severity of “Normal”.

버전

version 속성을 사용하여 보고된 버그가 식별된 버전을 나타낼 수 있습니다.

UI/UX

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

Cc

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

키워드

With this field you may label a ticket with multiple keywords. This can be useful, for example, to group several tickets on the same theme. Keywords can either be comma or space separated. Keyword search finds the keyword string anywhere in the keywords. For example, clicking on a ticket with the keyword “form” will yield similar tickets tagged with keywords containing strings such as “formset”, “modelformset”, and “ManagementForm”.

티켓 종료

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

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

• 문제가 해결되었는지 확인하십시오.
• 티켓 마감 결정을 설명하는 댓글을 남겨주세요.
• 그들이 티켓을 개선해서 다시 열 수 있는 방법이 있다면, 그들에게 알려주십시오.
• 티켓이 중복된 경우 원래 티켓을 참조하십시오. 또한 원래 티켓에 설명을 남겨 닫힌 티켓을 상호 참조합니다. 이렇게 하면 보고된 버그 또는 요청된 기능에 대한 더 많은 관련 정보에 액세스할 수 있습니다.
• 예의를 지키세요. 아무도 그들의 티켓이 닫히는 것을 좋아하지 않습니다. 그것은 좌절감을 주거나 심지어 낙담시킬 수 있습니다. 사람들이 장고에 기여하는 것을 꺼리는 것을 피하는 가장 좋은 방법은 예의 바르고 친근하게 대하는 것이고 그들이 앞으로 이 티켓과 다른 티켓들을 개선할 수 있는 방법에 대한 제안을 하는 것입니다.

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

• 고정됨

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

• 무효함

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

• 고쳐지지 않다

  Used when someone decides that the request isn’t appropriate for consideration in Django. Sometimes a ticket is closed as “wontfix” with a request for the reporter to start a discussion on the django-developers mailing list if they feel differently from the rationale provided by the person who closed the ticket. Other times, a mailing list discussion precedes the decision to close a ticket. Always use the mailing list to get a consensus before reopening tickets closed as “wontfix”.

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

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

• 나를 위해 일하다

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

• 정보가 필요하다.

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

티켓이 잘못 닫혔다고 생각되는 경우(아직 문제가 발생했거나, 다른 곳에서 티켓이 표시되었거나, 트라이저가 실수를 했기 때문에) 티켓을 다시 열고 추가 정보를 제공하십시오. 다시 한 번 말하지만, “wontfix”로 표시된 티켓을 다시 열지 말고 대신 |django-developers|로 문제를 가져와 주십시오.

트리징을 어떻게 도울 수 있을까요?

분류 과정은 주로 지역 사회 구성원들에 의해 주도된다. 정말, **누구나**가 도울 수 있습니다.

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

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

• 검토되지 않은 티켓을 “잘못된”, “작업 가능”, “복제” 또는 “원픽스”로 닫는 중입니다.
• 설명이 너무 희박하여 실행이 불가능하거나 |django-developers|에 대한 토론이 필요한 기능 요청인 경우 “검토되지 않은” 티켓을 “needsinfo”로 닫습니다.
• 티켓이 잘못 설정된 티켓에 대해 “테스트 필요”, “문서 필요” 또는 “패치 있음” 플래그를 수정합니다.
• 크기가 작고 비교적 간단한 티켓에 ‘쉬운 픽킹’_ 플래그를 설정합니다.
• 아직 분류되지 않은 티켓의 *유형*을 설정합니다.
• 이전 티켓이 여전히 유효한지 확인하는 중입니다. 티켓이 오랫동안 활동을 하지 않은 경우 문제는 해결되었지만 티켓이 아직 닫히지 않았을 수 있습니다.
• 티켓의 추세 및 테마 식별. Django의 특정 부분에 대한 버그 보고서가 많으면 코드의 해당 부분을 리팩터링하는 것을 고려해야 한다는 것을 나타낼 수 있습니다. 유행이 떠오르면 |django-developers|에서 토론(관련 티켓 참조)을 위해 올려야 합니다.
• 다른 사용자가 제출한 패치가 올바른지 확인합니다. 올바른 문서와 테스트가 포함된 경우, “체크인 준비” 단계로 이동합니다. 올바르지 않은 경우 코멘트를 남겨 그 이유를 설명하고 해당 플래그를 설정합니다(“패치 개선 필요”, “테스트 필요” 등).

참고

‘Reports page’_에는 위에서 제안한 바와 같이 티켓을 분류하고 패치를 검토하는 데 유용한 몇 가지 트랙 쿼리에 대한 링크가 포함되어 있습니다.

더 많은 :doc:’new-contributors’도 찾을 수 있습니다.

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

• Please don’t promote your own tickets to “Ready for checkin”. You may mark other people’s tickets that you’ve reviewed as “Ready for checkin”, but you should get at minimum one other community member to review a patch that you submit.
• 합의점을 찾기 위해 |django-developers|에게 메시지를 올리지 않고 결정을 번복하지 마십시오.
• 변경해야 하는지 확실하지 않으면 변경하지 말고 티켓에 대한 우려 사항을 적어 두거나 |django-developers|에게 메시지를 게시하십시오. 확실하지 않은 것은 괜찮지만, 여러분의 의견은 여전히 가치가 있습니다.

회귀 분석 이등분

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

먼저 이 문제에 대한 장고의 테스트 제품군에 대한 회귀 테스트를 작성하십시오. 예를 들어, 마이그레이션에서 회귀 분석을 디버깅하는 것으로 가정합니다. 테스트를 작성하고 최신 기본 분기에서 실패하는 것을 확인한 후 독립 실행이 가능한 별도의 파일에 테스트를 넣습니다. 이 예에서는 "tests/migration/test_regression"을 만든 것으로 가정합니다.pycl, 다음을 사용하여 실행할 수 있습니다.

$ ./runtests.py migrations.test_regression

다음으로, 테스트 실패 이후 기록의 현재 지점을 “나쁨”으로 표시합니다.

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

Now, we need to find a point in git history before the regression was introduced (i.e. a point where the test passes). Use something like git checkout HEAD~100 to check out an earlier revision (100 commits earlier, in this case). Check if the test fails. If so, mark that point as “bad” (git bisect bad), then check out an earlier revision and recheck. Once you find a revision where your test passes, mark it as “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 티켓에 결과를 보고하고, 회귀 테스트를 첨부 파일로 포함시켜 주세요. 누군가가 버그에 대한 수정 사항을 작성할 때, 그들은 이미 당신의 테스트를 시작점으로 가지고 있을 것이다.