跳轉到內容

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.txtREADME.md

在包含新的外部庫時,請嘗試在許多不同的系統上測試它。GNU Compile Farm 可以提供幫助,模擬器系統(如 Qemu 或 VMWare)也可以提供幫助。檢視 Mac OSX 和 Linux/Unix 的“build-dependencies”指令碼(在 /scripts 下)。如果可能,請嘗試交叉編譯到 Windows(參見 README.md

提交補丁的步驟

[編輯 | 編輯原始碼]
  • 在 OpenSCAD 郵件列表中搜索該主題,看看它是否曾被討論過(例如,如果想新增一個關於顏色的補丁,請在網上搜索“openscad 郵件列表 顏色”)。在建立補丁時考慮這些討論。
  • 如果您不熟悉 git,請仔細閱讀 git 教程(如 [1] 中的教程)。
  • 在 github 上製作您自己的 openscad 分支
  • 將您的新分支克隆到本地機器上
  • 對 openscad 進行修改。測試您的修改。
  • 將您的更改提交到本地儲存庫,並將它們推送到 github 上您分叉的 openscad 中。
  • 透過閱讀“doc/testing.txt”執行所有迴歸測試。確保您的補丁不會破壞任何東西。如果感到困惑,請諮詢郵件列表。
  • 如果您的補丁添加了新功能,請為其建立一個新的迴歸測試,並將該測試以及測試結果 .png 檔案提交到您的分支。參見 doc/testing.txt。
  • 如有必要,更新所有文件,包括 RELEASE NOTES、README.md 和 openscad 手冊頁,以反映您的更改。還要準備好更新 Wiki 手冊。
  • 準備好後,單擊 github 上您分支的“拉取請求”按鈕。仔細檢視您的程式碼與 OpenSCAD Master 分支之間的差異。
  • 準備好後,提交拉取請求。

也可以使用“git diff”建立小的補丁,並將其釋出到 郵件列表,但 github 更加可取。

  1. [2]
  2. [3]
華夏公益教科書