开发#
Angie是一个开源项目,欢迎所有贡献者。
源代码#
编码风格#
您的更改应与Angie代码的其余部分保持一致; nginx编码指南 是一个很好的起点。 不过,请注意在API代码中有显著差异。
小技巧
如果有疑问,请检查附近的代码以供参考, 或者直接在代码库中搜索以获取灵感。
提交信息#
以一行摘要开始说明所完成的工作。 它可以有一个前缀,提交日志使用该前缀来标识受影响的代码部分。 摘要最多可以有67个字符, 并可能跟随一个空行和更多详细信息。
一条好的消息说明了变化的原因、所做的工作, 以及当前的情况:
API: 移除了不好的东西,添加了好的东西。
如其他地方所述[1],原始API不佳是因为某些原因;
此更改旨在局部改进该方面。
已实施多种良好级别以减轻不良影响;
这现已成为首选的工作方式。此外,不良影响已消除。
[1] https://example.com
可能被忽视的细节:
摘要以句号结尾,并使用句子格式。
摘要前缀后跟小写字母。
单行内的句子之间用双空格分隔。
最终检查#
尽最大努力验证更改在*所有*目标平台上都有效。
-
对于每个平台,运行测试套件以确保没有回归:
$ cd tests $ prove .
有关详细信息,请参阅
tests/README
文件。 确保您对 法律条款 感到满意。
提交贡献#
目前,我们无法接受直接提交到我们的代码库; 请在我们的 GitHub镜像 上创建一个PR。
如有问题或建议,请通过 GitHub问题 联系开发者。