编写第一个Django补丁

本节前提

至少对Django的运行方式有一定的认识。可以很容易的通读或者编写一个Django应用程序。还应该对于Python有很好的理解。若不是很熟悉Python，请看《Dive Into Python》对于初学者是一本很棒的在线电子书。

将包含以下内容

安装Git

如何下载Django的开发版本

为补丁写一个测试

为补丁编写代码

测试补丁

提交一个pull request(PR)

在哪里找更多信息

必须Python3！

安装Git

获得一个Django开发版本的副本

为 Django 做贡献的第一步就是获取源代码副本。先fork Github 上的 Django 项目 。然后使用命令来clone一份Django的源码库。

使用virtualenv创建隔离的Python环境

使用方法参考文章《

Python之virtualenv 简介

》

回滚到之前的某一Django版本

git checkout xxxxxx

运行Django的测试套件

避免给其他部分引入新的bug。在你更改代码之后，检查Django是否能正常工作，就是运行Django的测试套件。如果测试通过，就有理由相信改动没有破坏Django。

安装测试依赖

pip install -r requirements/py3.txt

运行测试套件

./runtests.py

为补丁创建一个分支

git checkout -b ticket_24788

为工单写一些测试用例

Django的补丁（或者其他任何系统）必须包含测试。Bug 修复补丁的测试是一个回归测试，确保该 Bug 不会再次在 Django 中出现。该测试应该在 Bug 存在时测试失败，在 Bug 已经修复后通过测试。

运行测试

进入Django的tests目录并运行

./runtests.py xxxxxx

预览修改

git diff

提交补丁中的修改

git commit -a -m "fixed xxx"

推送这次提交并生成一个pull请求

git push origin ticket_xxx

你可以访问 Django GitHub page 创建一个 pull 请求。 你会在“你最近推送的分支”下看到你的分支。 单击旁边的 "Compare & pull request"。

此处请不要这么做。不过，在接下来显示补丁预览的页面，你可以单击 "Create pull request"。

本节仅是针对如何提交和修改补丁做一个最简单的阐述。这种修改方法，同样适用于其他的任何GitHub上的项目。鉴于笔者现在技术实力尚浅，暂无实践奉上。

谢谢！