티켓 분류

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 유지보수의 부하를 커뮤니티에 분배함으로써 실수가 있을 것으로 받아들입니다. 트랙은 “대부분 정확”하며, 때때로 틀릴 수 있다는 사실에 대해 허용합니다. 괜찮아요. 우리는 마감일이 있는 완벽주의자입니다.

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

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

분류 워크플로우

Unfortunately, not all bug reports and feature requests in the ticket tracker provide all the required details. A number of tickets have proposed solutions, but those don’t necessarily meet all the requirements adhering to the guidelines for contributing.

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

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

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

Django의 티켓 분류 워크플로우

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

  • Mergers: people with commit access who are responsible for making the final decision to merge a change.

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

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

  • Alice가 티켓을 만들고 불완전한 풀 요청(테스트 없음, 잘못된 구현)을 보냅니다.

  • 밥은 풀 요청을 검토하고 티켓을 “승인됨”, “테스트 필요”, “패치 개선 필요”로 표시하고 앨리스에게 패치를 개선할 수 있는 방법을 알려주는 댓글을 남깁니다.

  • Alice는 풀 요청을 업데이트하고 테스트를 추가합니다(실행을 변경하지 않음). 그녀는 두 개의 플래그를 제거합니다.

  • Charlie는 풀 요청을 검토하고 “패치 개선 필요” 플래그를 구현 개선에 대한 다른 설명과 함께 재설정합니다.

  • 앨리스는 풀 요청을 업데이트하여 구현을 수정합니다. 그녀는 “패치 개선 필요” 플래그를 제거합니다.

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

  • 제이콥(a :ref:’merge’)은 풀 요청을 검토하고 병합합니다.

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

분류 단계

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

리뷰 되지 않음

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

확인됨

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

  • 승인 + 플래그 없음

    The ticket is valid, but no one has submitted a patch for it yet. Often this means you could safely start writing a fix for it. This is generally more true for the case of accepted bugs than accepted features. A ticket for a bug that has been accepted means that the issue has been verified by at least one triager as a legitimate bug - and should probably be fixed if possible. An accepted new feature may only mean that one triager thought the feature would be good to have, but this alone does not represent a consensus view or imply with any certainty that a patch will be accepted for that feature. Seek more feedback before writing an extensive contribution if you are in doubt.

  • 승인됨 + 패치 있음

    The ticket is waiting for people to review the supplied solution. This means downloading the patch and trying it out, verifying that it contains tests and docs, running the test suite with the included patch, and leaving feedback on the ticket.

  • 승인 + 패치 + 니즈…

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

체크인 준비

The ticket was reviewed by any member of the community other than the person who supplied the patch and found to meet all the requirements for a commit-ready contribution. A merger now needs to give a final review prior to being committed.

풀 요청이 많아요. 패치를 검토하는 데 시간이 걸릴 수 있습니다. 여기서 몇 가지 아이디어를 얻으려면: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.

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

기타 분류 속성

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

패치 있음

This means the ticket has an associated solution. These will be reviewed to ensure they adhere to the documented guidelines.

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

문서 필요

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

테스트 필요

This flags the patch as needing associated unit tests. Again, this is a required part of a valid contribution.

패치 개선 필요

This flag means that although the ticket has a solution, it’s not quite ready for checkin. This could mean the patch no longer applies cleanly, there is a flaw in the implementation, or that the code doesn’t meet our standards.

손쉬운 선택

Tickets that would require small, easy, changes.

타입

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

  • 새 기능

    새로운 걸 추가해줘서.

  • 버그

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

  • 정리/최적화

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

요소

티켓은 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 Forum or django-developers mailing list if they feel differently from the rationale provided by the person who closed the ticket. Other times, a discussion precedes the decision to close a ticket. Always use the forum or mailing list to get a consensus before reopening tickets closed as “wontfix”.

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

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

  • 나를 위해 일하다

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

  • 정보가 필요하다.

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

If you believe that the ticket was closed in error – because you’re still having the issue, or it’s popped up somewhere else, or the triagers have made a mistake – please reopen the ticket and provide further information. Again, please do not reopen tickets that have been marked as “wontfix” and bring the issue to the Django Forum or django-developers instead.

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

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

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

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

  • 검토되지 않은 티켓을 “잘못된”, “작업 가능”, “복제” 또는 “원픽스”로 닫는 중입니다.

  • Closing “Unreviewed” tickets as “needsinfo” when the description is too sparse to be actionable, or when they’re feature requests requiring a discussion on the Django Forum or django-developers.

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

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

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

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

  • Identifying trends and themes in the tickets. If there are a lot of bug reports about a particular part of Django, it may indicate we should consider refactoring that part of the code. If a trend is emerging, you should raise it for discussion (referencing the relevant tickets) on the Django Forum or django-developers.

  • Verify if solutions submitted by others are correct. If they are correct and also contain appropriate documentation and tests then move them to the “Ready for Checkin” stage. If they are not correct then leave a comment to explain why and set the corresponding flags (“Patch needs improvement”, “Needs tests” etc.).

참고

The Reports page contains links to many useful Trac queries, including several that are useful for triaging tickets and reviewing proposals as suggested above.

더 많은 :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.

  • Please don’t reverse a decision without posting a message to the Django Forum or django-developers to find consensus.

  • If you’re unsure if you should be making a change, don’t make the change but instead leave a comment with your concerns on the ticket, or post a message to the Django Forum or django-developers. It’s okay to be unsure, but your input is still valuable.

회귀 분석 이등분

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

Begin by writing a regression test for Django’s test suite for the issue. For example, we’ll pretend we’re debugging a regression in migrations. After you’ve written the test and confirmed that it fails on the latest main branch, put it in a separate file that you can run standalone. For our example, we’ll pretend we created tests/migrations/test_regression.py, which can be run with:

$ ./runtests.py migrations.test_regression

Next, we mark the current point in history as being “bad” since the test fails:

$ 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)
...

Now we’re ready for the fun part: using git bisect run to automate the rest of the process:

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

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

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

Back to Top