对新投稿人的建议

新的贡献者,不确定该怎么做?想帮忙但不知道怎么开始?这是给你的。

站起来,跑起来!

如果你刚开始为Django做贡献, 为Django编写第一个补丁 教程将向您介绍工具和工作流。

这一页包含了更多关于如何为Django做出贡献以及如何实现的一般性建议。

如果您正在寻找有关编写代码的详细信息的参考资料,请参阅 编写代码 文件。

第一步

从以下步骤开始了解Django的开发过程。

  • 分类标签

    如果一个 unreviewed ticket 报告一个错误,尝试复制它。如果您可以复制它,并且它看起来是有效的,那么请记下您确认了错误并接受了票据。确保票据在正确的组件区域下归档。考虑编写一个补丁来添加对bug行为的测试,即使您不修复bug本身。更多见 我如何帮助试诊?

  • 查找已接受的通知单,并查看修补程序以熟悉代码库和流程

    如果补丁需要文档或测试,请标记相应的标志。仔细检查补丁所做的更改,注意语法是否与旧的但仍受支持的Python版本不兼容。 Run the tests 确保他们通过。如果可能并且相关,可以在sqlite以外的数据库中进行尝试。留下评论和反馈!

  • 使旧补丁保持最新

    通常情况下,代码库会在提交补丁和审阅补丁之间发生变化。确保它仍然干净地应用,并按预期运行。更新补丁既有用又重要!查看更多 正在提交修补程序 .

  • 写一些文件

    Django的文档很好,但它总是可以改进的。你发现打字错误了吗?你认为应该澄清一些事情吗?继续建议文档修补程序!另请参见上的指南 编写文档 .

    备注

    这个 reports page 包含指向许多有用的TRAC查询的链接,其中包括一些对于筛选票据和查看上面建议的补丁程序有用的链接。

  • 签署贡献者许可协议

    你写的代码属于你或你的雇主。如果您的贡献超过一行或两行代码,则需要在 CLA . 见 Contributor License Agreement FAQ 更详细的解释。

指南

作为一个大型项目的新人,很容易感到沮丧。以下是一些建议,让你在 Django 的工作更有用,更有益。

  • 选择你关心、熟悉或想了解的主题领域

    您不必成为您想要工作领域的专家;您可以通过对代码的持续贡献成为专家。

  • 分析票据的上下文和历史记录

    trac不是绝对的;上下文和单词一样重要。阅读TRAC时,你需要考虑到谁说了什么,以及他们什么时候说了什么。两年前对一个想法的支持并不一定意味着这个想法仍然会得到支持。你还需要注意谁 还没有 口语——例如,如果一个有经验的投稿人最近没有参与讨论,那么一张票可能没有进入Django所需的支持。

  • 从小做起

    在小问题上得到反馈比在大问题上容易。见 easy pickings .

  • 如果你要从事一项大任务,首先要确保你的想法得到支持。

    这意味着在修复问题之前让其他人确认一个bug是真实的,并确保在您开始实施它之前,就一个提议的特性达成共识。

  • 大胆点!留下反馈!

    有时候,把你的观点告诉世界,说“这张票是正确的”或者“这个补丁需要工作”,可能会很可怕,但这是项目前进的唯一方式。广大Django社区的贡献最终会比任何一个人产生更大的影响。我们不能没有 you 你说什么?

  • Err on the side of caution when marking things Ready For Check-in

    如果你真的不确定一张票是否准备好了,不要这样做。留下评论,让别人知道你的想法。如果你基本上是确定的,但不是完全确定的,你也可以试着问IRC看看是否有人能证实你的怀疑。

  • 等待反馈,并对收到的反馈做出响应

    把注意力集中在一两张票上,从头到尾看一遍,然后重复。拿了很多票,让一些票掉在路边的散弹枪方法,结果弊大于利。

  • 要严谨

    当我们说“:pep:8”,并且必须有文档和测试时,我们是认真的。如果一个补丁没有文档和测试,最好有一个很好的理由。像“我找不到任何关于这个特性的现有测试”这样的论点没有太大的分量——虽然这可能是真的,但这意味着你有额外重要的工作来为这个特性编写第一个测试,而不是说你完全通过了编写测试。

  • Be patient

    要快速查看您的机票或补丁并不总是那么容易。这不是私人恩怨。有很多门票和拉票请求才能通过。

    让您的补丁保持最新很重要。检查Trac上的票证以确保 Needs testsNeeds documentation ,以及 Patch needs improvement 一旦您处理了所有的评论评论,标志就会被取消选中。

    记住,Django有八个月的发布周期,所以有足够的时间来审查你的补丁。

    最后,适时的提醒可能会有所帮助。看见 contributing code FAQ 在这里寻找点子。