分类工单

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.

Similarly, while we aim for Trac to be a perfect representation of the state of Django's progress, we acknowledge that this will not happen. By distributing the load of Trac maintenance to the community, we accept that there will be mistakes. Trac is "mostly accurate", and we give allowances for the fact that sometimes it will be wrong. That's okay. We're perfectionists with deadlines.

We rely on the community to keep participating, keep tickets as accurate as possible, and raise issues for discussion on our mailing lists when there is confusion or disagreement.

Django是一个社区项目，每个贡献都有帮助。没有**你**我们不能这样做！

分诊工作流

不幸的是，并不是工单跟踪程序中的所有bug报告和功能请求都提供 required details 。很多工单都有补丁，但这些补丁并不满足一个 good patch 的要求。

One way to help out is to triage tickets that have been created by other users.

大多数工作流都是基于工单的 :ref:`triage stages ` 。每个阶段都描述了在其生命周期中，给定的工单在任何时间的位置。除了一些标志，这个属性可以很容易地告诉我们每张工单在等待什么和谁。

既然一张图片胜过千言万语，那就从这里开始吧：

Django's ticket triage workflow

在这张图表中我们有两个角色：

  • Mergers: people with commit access who are responsible for making the final decision to merge a patch.
  • 工单分拣员：Django社区中选择参与Django开发过程的任何人。我们的Trac装置有意对公众开放，任何人都可以对工单进行分类。Django是一个社区项目，我们鼓励 triage by the community 。

举个例子，我们可以看到一张普通工单的生命周期：

  • Alice创建一个工单并发送一个不完整的请求（没有测试，实现也不正确）。
  • Bob reviews the pull request, marks the ticket as "Accepted", "needs tests", and "patch needs improvement", and leaves a comment telling Alice how the patch could be improved.
  • Alice更新pull请求，添加测试（但不更改实现）。她把两个旗子摘了下来。
  • Charlie检查pull请求并用另一条关于改进实现的注释重置“patch needs improvement”标志。
  • Alice更新了pull请求，修复了实现。她去掉了“patch needs improvement”的标志。
  • Daisy检查pull请求并将工单标记为“Ready for checkin”。
  • Jacob, a merger, reviews the pull request and merges it.

有些工单需要的反馈比这少得多，但同样有些工单需要更多的反馈。

分类阶段

下面我们将更详细地描述工单在其生命周期中可能经历的各个阶段。

没有审阅

没有任何人对工单是否包含有效问题、可行功能或是否应因任何原因关闭而对工单进行审阅。

已接受

大灰色区域！“已接受”的绝对含义是，工单中描述的问题是有效的，并且正处于处理的某个阶段。除此之外，还有几个考虑因素：

  • 已接受并且没有标识

    工单是有效的，但是还没有人提交补丁。通常这意味着您可以安全地开始为它编写补丁。对于可接受的bug，这通常比接受的特性更真实。对于一个已经被接受的bug的工单意味着这个问题已经被至少一个trigger验证为合法的bug，并且如果可能的话应该被修复。一个被接受的新特性可能只意味着一个试验者认为该特性将是好的，但这本身并不代表一致的观点，也不意味着某个补丁将被接受。如果您有疑问，请在编写大量补丁之前寻求更多反馈。

  • 已接受并且有补丁

    工单正在等待人们查看提供的修补程序。这意味着下载并试用补丁，验证它是否包含测试和文档，使用包含的补丁运行测试套件，并在工单上留下反馈。

  • 已接受并且有补丁，需要...

    这意味着工单已经过审核，需要进一步的工作。“需求测试”和“需求文档”是不言而喻的，“补丁需要改进”通常会在工单上附上注释，解释需要改进的代码。

准备收入

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 patch. A merger now needs to give the patch a final review prior to being committed.

There are a lot of pull requests. It can take a while for your patch to get reviewed. See the contributing code FAQ for some ideas here.

几天/可能

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

这些工单并不常见，而且总体上没有多大用处，因为它们没有描述具体的可操作问题。如果提交了一个优秀的补丁，我们可能会考虑在框架中添加这些增强请求。它们不是优先考虑的问题。

其他分类属性

A number of flags, appearing as checkboxes in Trac, can be set on a ticket:

有补丁

这意味着工单有一个关联的 patch 。这些将被审阅，看看补丁是否“良好”。

以下三个字段（需要文档、需要测试、补丁需要改进）仅适用于提供了补丁的情况。

需要文档

此标志用于具有需要相关文档的修补程序的工单。完整的特性文档是我们将它们检入代码库之前的先决条件。

需要测试

这会将补丁标记为需要相关联的单元测试。同样，这是有效补丁程序的必需部分。

补丁需要改进

此标志表示虽然工单 *有*个补丁，但还没有完全准备好检入。这可能意味着补丁没有干净地应用，实现中存在缺陷，或者代码不符合我们的标准。

容易挑选

需要小的，容易的补丁的工单。

类型

工单应该按*类型*分类

  • 新特性
    为了添加一些新东西。
  • 错误
    指☞一些损坏的或者行为与预期不符的地方。
  • 清理/优化
    指那些没有东西被破坏，同时有一些东西可以变得更干净、更好、更快、更强的地方。

组件

工单应该被分类到*组件*中，指出它们属于Django代码库的哪个区域。这使得工单更有条理，更容易找到。

严重性

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*属性来指示在哪个版本中发现了报告的bug。

UI/UX

此标志用于与用户界面和用户体验问题相关的工单。例如，此标志适用于表单或管理后台接口界面中面向用户的功能。

副本

您可以将您的用户名或电子邮件地址添加到该字段，以便在对工单进行新的投稿时收到通知。

关键词

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 贡献的最好方法是礼貌友好，并为他们将来如何改进这张工单和其他工单提供建议。

工单可以通过多种方式收尾：

  • 已修复
    在Django中添加补丁并修复问题后使用。
  • 无效
    如果发现工单不正确，则使用。这意味着工单中的问题实际上是用户错误的结果，或者描述的是Django之外的问题，或者根本不是bug报告或特性请求（例如，一些新用户将支持查询作为工单提交）。
  • 不会修复
    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上创建一个账户”_ 。如果您有账户但忘记了密码，可以使用 “密码重置页”_ 重置它。

然后，你可这样帮忙：

  • 以“无效”、“工作表”或“复制”或“wontfix”关闭“未审核”票据。
  • 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.
  • 当描述太少而无法操作时，或者当它们是需要在| django developers |中讨论的功能请求时，将“unreview”工单作为“needsinfo”关闭。
  • 配置 "Easy pickings" 标志，用于较小且相对简单的工单。
  • 设置尚未分类的工单的 类型 。
  • 检查原工单是否仍然有效。如果一个工单在一长段时间里未发现任何活动，则有可能其问题已经修复但工单尚未关闭。
  • 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.
  • 验证其他用户提交的修补程序是否正确。如果它们是正确的并且还包含适当的文档和测试，那么将它们移到“准备签入”阶段。如果它们不正确，请留下注释解释原因并设置相应的标志（“补丁需要改进”、“需要测试”等）。

备注

Reports page 包含指向许多有用的Trac查询的链接，其中包括一些对筛选工单和查看上面建议的修补程序很有用的查询。

你可以找到更多的 对新贡献者的建议 。

但是，我们确实要求在工单数据库中工作的所有普通社区成员：

  • 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.

平等回归

回归是一些较新版本的Django中存在，而较旧的版本中没有的错误。 引入回归的提交是非常有用的信息。了解导致行为改变的提交有助于识别改变是有意的还是无意的副作用。以下是您如何确定这个的。

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工单上报告您的结果，并在附件中包含回归测试。当某人为该错误编写修复程序时，他们已经以您的测试为起点。

« previous | up | next »