贡献变更

获取源码

Mercurial 是一个源码存储工具。可使用以下命令源码仓库：

  1. hg clone http://hg.nginx.org/nginx

格式化变更

变更应根据 nginx 使用的代码样式进行格式化。代码格式化不应该依赖于诸如语法高亮或自动换行等编辑器功能。以下是一些基本规则：

  • 最大文本宽度为 80 个字符
  • 缩进为四个空格
  • 没有 tab（制表符）
  • 文件中的逻辑代码块用两行空行分隔

参照现有 nginx 源码的格式，在您的代码中模仿此样式。如果风格与周围的代码相一致，则更改更容易被接受。

提交更改以创建一个 Mercurial 变更集（changeset）。请确保指定的 电子邮件 和变更作者的真实姓名正确无误。

提交消息应是单行简述，后跟一行空行加描述内容。第一行最好不要超过 67 个符号。可以使用 hg export 命令获得一个结果变更集 patch：

  1. # HG changeset patch
  2. # User Filipe Da Silva <username@example.com>
  3. # Date 1368089668 -7200
  4. #      Thu May 09 10:54:28 2013 +0200
  5. # Node ID 2220de0521ca2c0b664a8ea1e201ce1cb90fd7a2
  6. # Parent  822b82191940ef309cd1e6502f94d50d811252a1
  7. Mail: removed surplus ngx_close_connection() call.
  9. It is already called for a peer connection a few lines above.
  11. diff -r 822b82191940 -r 2220de0521ca src/mail/ngx_mail_auth_http_module.c
  12. --- a/src/mail/ngx_mail_auth_http_module.c      Wed May 15 15:04:49 2013 +0400
  13. +++ b/src/mail/ngx_mail_auth_http_module.c      Thu May 09 10:54:28 2013 +0200
  14. @@ -699,7 +699,6 @@ ngx_mail_auth_http_process_headers(ngx_m
  16.                      p = ngx_pnalloc(s->connection->pool, ctx->err.len);
  17.                      if (p == NULL) {
  18. -                        ngx_close_connection(ctx->peer.connection);
  19.                          ngx_destroy_pool(ctx->pool);
  20.                          ngx_mail_session_internal_server_error(s);
  21.                          return;

提交前

提交更改前，有几点值得思考：

  • 建议的变更应能在大部分的 支持平台 上正常工作。
  • 尽量说明清楚为什么需要更改，如果可以的话，请提供一个用例。
  • 通过测试套件传递您的更改是确保不会导致回归的好方法。可以使用以下命令克隆测试仓库：
  1. hg clone http://hg.nginx.org/nginx-tests

提交变更

提议的更改应发送到 nginx 开发 邮件列表。提交更改集的首选便捷方法是使用 patchbomb 扩展。

许可证

提交变更意味着授予项目一个权限以在一个适当的许可证下使用它。

原文档

http://nginx.org/en/docs/contributing_changes.html