Submitting contributions

We're always grateful for contributions to Django's code. Indeed, bug reports with associated contributions will get fixed far more quickly than those without a solution.

错字修复和琐碎的文档更改

如果您正在修复一个非常微不足道的问题，例如更改文档中的一个单词，推荐的方法是使用 GitHub 提交拉取请求，而无需使用 Trac 工单。

有关如何使用拉取请求的更多详细信息，请参见 使用 Git 和 GitHub 工作 。

“发布”工单

在一个全球有数百个贡献者的开源项目中，有效地管理沟通以避免重复工作并尽可能提高贡献者的效率是非常重要的。

因此，我们的政策是供贡献者“发布”工单，以便让其他开发人员知道正在处理特定的错误或功能。

如果您确定了要做出的贡献并且有能力解决（通过编程能力，Django内核知识水平和时间可用性来衡量），请按照以下步骤进行发表：

  • 使用您的 GitHub 帐户登录 或在我们的工单系统中 创建一个帐户。如果您有帐户但忘记了密码，可以使用 密码重置页面 进行重置。

  • 如果尚无此问题的工单，请在我们的 ticket tracker 工单追踪系统中创建一个。

  • 如果此问题已有相关工单，请确保没有其他人认领。要做到这一点，查看工单的 " Owned by "（负责人）部分。如果它被分配给了 " nobody "（无人认领），那么它可以被认领。否则，可能已经有其他人正在处理此工单。您可以选择另一个错误或功能来处理，或者联系负责此工单的开发人员提供帮助。如果一个工单在数周或数月内没有任何活动，那么将其重新分配给自己可能是安全的。

  • Log into your account, if you haven't already, by clicking "GitHub Login" or "DjangoProject Login" in the upper left of the ticket page. Once logged in, you can then click the "Modify Ticket" button near the bottom of the page.

  • Claim the ticket by clicking the "assign to" radio button in the "Action" section. Your username will be filled in the text box by default.

  • Finally click the "Submit changes" button at the bottom to save.

Note

The Django software foundation requests that anyone contributing more than a trivial change to Django sign and submit a Contributor License Agreement, this ensures that the Django Software Foundation has clear license to all contributions allowing for a clear license for all users.

工单发表者的责任

发布工单后，您有责任以合理及时的方式处理该工单。 如果您没有时间来处理它，请先取消发布或不发布它！

如果一两周内没有任何关于特定已发布工单的进展迹象，则另一位开发人员可能会要求您放弃该发布了的工单，以使其不再被垄断，而其他人也可以发布。

如果您已发布工单，并且要花很长时间（几天或几周）编写代码，请通过在工单上发布评论来使每个人都保持最新状态。如果您不提供定期更新，并且不响应进度报告的请求，则您对工单的要求可能会被撤消。

与往常一样，多交流好过少交流！

应该发布哪类工单？

在某些情况下，执行认领工单的步骤可能过于繁琐。

In the case of small changes, such as typos in the documentation or small bugs that will only take a few minutes to fix, you don't need to jump through the hoops of claiming tickets. Submit your changes directly and you're done!

It is always acceptable, regardless whether someone has claimed it or not, to link proposals to a ticket if you happen to have the changes ready.

Contribution style

确保您所做的任何贡献至少满足以下要求：

  • The code required to fix a problem or add a feature is an essential part of a solution, but it is not the only part. A good fix should also include a regression test to validate the behavior that has been fixed and to prevent the problem from arising again. Also, if some tickets are relevant to the code that you've written, mention the ticket numbers in some comments in the test so that one can easily trace back the relevant discussions after your patch gets committed, and the tickets get closed.

  • If the code adds a new feature, or modifies the behavior of an existing feature, the change should also contain documentation.

When you think your work is ready to be reviewed, send a GitHub pull request. If you can't send a pull request for some reason, you can also use patches in Trac. When using this style, follow these guidelines.

  • 请以 git diff 命令返回的格式提交补丁。

  • 使用“附加文件”按钮将补丁附加到 ticket tracker 工单跟踪系统中的工单上。 除非是单行补丁，否则请 不要 将补丁放入工单描述或注释中。

  • 用扩展名 .diff 命名补丁文件； 这将使工单跟踪系统应用正确的语法突出显示，这非常有帮助。

无论您以何种方式提交工作成果，请按照以下步骤操作。

  • Make sure your code fulfills the requirements in our contribution checklist.

  • 勾选工单上的 "Has patch" 复选框，并确保 "Needs documentation"、"Needs tests" 和 "Patch needs improvement" 复选框没有被勾选。这将使工单显示在 Development dashboard 的 "Patches needing review" 队列中。

Contributions which require community feedback

A wider community discussion is required when a patch introduces new Django functionality and makes some sort of design decision. This is especially important if the approach involves a deprecation or introduces breaking changes.

The following are different approaches for gaining feedback from the community.

The Django Forum or django-developers mailing list

You can propose a change on the Django Forum or django-developers mailing list. You should explain the need for the change, go into details of the approach and discuss alternatives.

Please include a link to such discussions in your contributions.

Third party package

Django does not accept experimental features. All features must follow our deprecation policy. Hence, it can take months or years for Django to iterate on an API design.

If you need user feedback on a public interface, it is better to create a third-party package first. You can iterate on the public API much faster, while also validating the need for the feature.

Once this package becomes stable and there are clear benefits of incorporating aspects into Django core, starting a discussion on the Django Forum or django-developers mailing list would be the next step.

Django Enhancement Proposal (DEP)

Similar to Python’s PEPs, Django has Django Enhancement Proposals or DEPs. A DEP is a design document which provides information to the Django community, or describes a new feature or process for Django. They provide concise technical specifications of features, along with rationales. DEPs are also the primary mechanism for proposing and collecting community input on major new features.

Before considering writing a DEP, it is recommended to first open a discussion on the Django Forum or django-developers mailing list. This allows the community to provide feedback and helps refine the proposal. Once the DEP is ready the Steering Council votes on whether to accept it.

Some examples of DEPs that have been approved and fully implemented:

弃用一个功能

Django 中的代码可能被弃用的原因有几个：

  • 如果一个功能在与向后兼容性不兼容的方式下进行了改进或修改，旧的功能或行为将被弃用。

  • 有时，Django 会包含一个 Python 库的后移版本，而该库在 Django 当前支持的 Python 版本中不包含。当 Django 不再需要支持不包含该库的旧版本 Python 时，该库将在 Django 中被弃用。

正如 弃用政策 所描述的那样，第一个弃用某项功能的 Django 版本（A.B）在调用被弃用功能时应该引发一个 RemovedInDjangoXXWarning 警告（其中 XX 是将要删除该功能的 Django 版本）。假设我们有良好的测试覆盖率，在启用警告的情况下，这些警告将在 运行测试套件 时转换为错误：python -Wa runtests.py。因此，在添加 RemovedInDjangoXXWarning 时，您需要消除或消除运行测试时生成的任何警告。

第一步是通过 Django 自身去除对被弃用行为的使用。接下来，您可以使用 ignore_warnings 装饰器来消除测试中实际测试被弃用行为的警告，可以在测试或类级别使用它：

  1. 在一个特定的测试中：

    from django.test import ignore_warnings
from django.utils.deprecation import RemovedInDjangoXXWarning


@ignore_warnings(category=RemovedInDjangoXXWarning)
def test_foo(self): ...

  2. 对于整个测试用例：

    from django.test import ignore_warnings
from django.utils.deprecation import RemovedInDjangoXXWarning


@ignore_warnings(category=RemovedInDjangoXXWarning)
class MyDeprecatedTests(unittest.TestCase): ...

您还应该为弃用警告添加一个测试：

from django.utils.deprecation import RemovedInDjangoXXWarning


def test_foo_deprecation_warning(self):
    msg = "Expected deprecation message"
    with self.assertWarnsMessage(RemovedInDjangoXXWarning, msg) as ctx:
        # invoke deprecated behavior
        ...
    self.assertEqual(ctx.filename, __file__)

重要的是在没有警告引用但在弃用结束时需要更改或删除的代码上方包含一个 RemovedInDjangoXXWarning 注释。这可能包括已添加以保持先前行为的钩子，或在弃用结束时不再需要或未使用的独立项目。例如：

import warnings
from django.utils.deprecation import RemovedInDjangoXXWarning


# RemovedInDjangoXXWarning.
def old_private_helper():
    # Helper function that is only used in foo().
    pass


def foo():
    warnings.warn(
        "foo() is deprecated.",
        category=RemovedInDjangoXXWarning,
        stacklevel=2,
    )
    old_private_helper()
    ...

最后，还有一些更新需要进行，以更新 Django 的文档：

  1. 如果现有功能已经在文档中记录，请使用 .. deprecated:: A.B 注解在文档中标记它为已弃用。如果适用，包括一个简短的描述和有关升级路径的说明。

  2. 将已弃用行为的描述以及升级路径（如果适用）添加到当前版本的发行说明（docs/releases/A.B.txt）中，放在 "Features deprecated in A.B" 标题下。

  3. 在适当的版本下，将一个条目添加到弃用时间表（docs/internals/deprecation.txt）中，描述将要被移除的代码。

一旦完成了这些步骤，你就完成了弃用过程。在每个 特性发布 中，与新版本匹配的所有 RemovedInDjangoXXWarning 都会被移除。

JavaScript contributions

For information on JavaScript contributions, see the JavaScript 补丁 documentation.

Optimization patches

Patches aiming to deliver a performance improvement should provide benchmarks showing the before and after impact of the patch and sharing the commands for reviewers to reproduce.

django-asv benchmarks

django-asv monitors the performance of Django code over time. These benchmarks can be run on a pull request by labeling the pull request with benchmark. Adding to these benchmarks is highly encouraged.

Contribution checklist

Use this checklist to review a pull request. If you are reviewing a pull request that is not your own and it passes all the criteria below, please set the "Triage Stage" on the corresponding Trac ticket to "Ready for checkin". If you've left comments for improvement on the pull request, please tick the appropriate flags on the Trac ticket based on the results of your review: "Patch needs improvement", "Needs documentation", and/or "Needs tests". As time and interest permits, mergers do final reviews of "Ready for checkin" tickets and will either commit the changes or bump it back to "Accepted" if further work needs to be done. If you're looking to become a merger, doing thorough reviews of contributions is a great way to earn trust.

Looking for a patch to review? Check out the "Patches needing review" section of the Django Development Dashboard.

Looking to get your pull request reviewed? Ensure the Trac flags on the ticket are set so that the ticket appears in that queue.

文档

  • 文档是否能够在没有任何错误的情况下构建（从 docs 目录执行 make html，或者在 Windows 上执行 make.bat html）？

  • 文档是否遵循 编写文档 中的写作风格指南？

  • 是否存在任何 拼写错误？

错误

  • 是否有适当的回归测试（在应用修复之前，测试应该失败）？

  • 如果是一个符合 Django 稳定版本的 可回退 的 bug，是否在 docs/releases/A.B.C.txt 中有一份发行说明？只会应用到主分支的 bug 修复不需要发行说明。

新功能

  • 是否有测试来 "运行" 所有新代码？

  • 是否在 docs/releases/A.B.txt 中有一份发行说明？

  • 是否为该功能提供了文档，并且文档是否适当地使用了 .. versionadded:: A.B 或 .. versionchanged:: A.B 进行了 注释 ？

弃用一个功能

请参阅 弃用一个功能 指南。

所有代码更改

  • 代码风格 是否符合我们的指南？是否有任何 black、blacken-docs、flake8 或 isort 错误？您可以安装 pre-commit 钩子来自动捕获这些错误。

  • 如果更改在任何方面不向后兼容，是否在发行说明（docs/releases/A.B.txt）中有说明？

  • Django 的测试套件是否通过？

所有工单

Back to Top