OpenSCAD 用户手册/提交补丁
外观
可以通过https://github.com/AriesTriputranto[1] Docs.github.com/AriesTriputranto][2]提交补丁。
OpenSCAD 项目页面位于 https://github.com/openscad/openscad
OpenSCAD 对制表符、空格等没有正式的指导方针。请尝试与您正在处理的文件中已有的内容保持一致。
除了 GUI 代码,应避免在所有内容中使用 QT。请改用 C++11 或 boost。目标是保持模块化。
模块化也扩展到 OpenCSG 和 CGAL。请注意试图将 CGAL/OpenCSG 依赖代码与“独立”代码分离的 #ifdefs。
有两个构建系统:用于 GUI 的 Qmake 和用于测试套件的 Cmake。请在两者下测试您的补丁。阅读 doc/testing.txt 和 README.md。
在包含新的外部库时,请尝试在许多不同的系统上测试它。GNU Compile Farm 可以提供帮助,模拟器系统(如 Qemu 或 VMWare)也可以提供帮助。查看 Mac OSX 和 Linux/Unix 的“build-dependencies”脚本(在 /scripts 下)。如果可能,请尝试交叉编译到 Windows(参见 README.md)
- 在 OpenSCAD 邮件列表中搜索该主题,看看它是否曾被讨论过(例如,如果想添加一个关于颜色的补丁,请在网上搜索“openscad 邮件列表 颜色”)。在创建补丁时考虑这些讨论。
- 如果您不熟悉 git,请仔细阅读 git 教程(如 [1] 中的教程)。
- 注册一个 github 帐户,并仔细阅读介绍性文档,例如 http://help.github.com/fork-a-repo/
- 在 github 上制作您自己的 openscad 分支
- 将您的新分支克隆到本地机器上
- 对 openscad 进行修改。测试您的修改。
- 经常将官方的 openscad 源代码合并回您的本地副本,以避免冲突
- 将您的更改提交到本地存储库,并将它们推送到 github 上您分叉的 openscad 中。
- 通过阅读“doc/testing.txt”运行所有回归测试。确保您的补丁不会破坏任何东西。如果感到困惑,请咨询邮件列表。
- 如果您的补丁添加了新功能,请为其创建一个新的回归测试,并将该测试以及测试结果 .png 文件提交到您的分支。参见 doc/testing.txt。
- 如有必要,更新所有文档,包括 RELEASE NOTES、README.md 和 openscad 手册页,以反映您的更改。还要准备好更新 Wiki 手册。
- 准备好后,单击 github 上您分支的“拉取请求”按钮。仔细查看您的代码与 OpenSCAD Master 分支之间的差异。
- 准备好后,提交拉取请求。
也可以使用“git diff”创建小的补丁,并将其发布到 邮件列表,但 github 更加可取。