Clojure

對此網站的貢獻

此網站是關於 Clojure 程式語言及其更大生態系統的內容開放原始碼存放庫,網址為 https://clojure.dev.org.tw

如果您想要指出網站中的問題或建議新頁面,您可以透過在 https://github.com/clojure/clojure-site/issues 提交 GitHub 問題來執行。

如果您想要做出貢獻(錯字、修改或新內容),您必須成為貢獻者並使用以下所述的流程

如何成為貢獻者

貢獻者必須在提交變更前簽署 Clojure 貢獻者協議。貢獻者協議 (CA) 賦予 Rich Hickey 和貢獻者共同的著作權益:貢獻者保留著作權,同時也授予 Rich Hickey 這些權利,作為開源專案贊助者。

CA 源自 Oracle 貢獻者協議 (OCA),用於 OpenJDK、Netbeans 和 OpenSolaris 專案等。有一個很好的 OCA 常見問題,回答了許多問題。

透過執行 CA,貢獻者保護 Clojure 網站內容,並保護適應專案以符合社群需求變化的彈性。為了讓 CA 有效,Clojure 專案必須取得所有貢獻的讓渡。請檢閱 CA 以完整了解其條款和條件。透過為 Clojure 貢獻原始碼或其他素材,您表示您與 Rich Hickey 針對此類貢獻簽署了 CA。為了追蹤貢獻者,您了解您的全名和使用者名稱可能會張貼在可透過公開網址存取的授權貢獻者清單網頁上。

若要完成協議,請填寫並提交 貢獻者協議(線上電子表單)。

請注意,如果您已簽署 Clojure 貢獻者協議以提供程式碼修補程式給 Clojure 原始碼,您不需要再次簽署,因為這是相同的協議。

提交小變更

小變更可以直接在 GitHub 網路介面中提出

  1. 前往內容儲存庫 https://github.com/clojure/clojure-site

  2. 瀏覽至您想要在 content/ 下更新的頁面 - 網址應該與檔案基本名稱相符。例如,此檔案的內容位於 https://github.com/clojure/clojure-site/blob/master/content/community/contributing_site.adoc

  3. 按一下編輯(鉛筆)圖示。

  4. 內容使用與 Markdown 相似的 asciidoc 格式撰寫。編輯 頁面列出您在編輯此網站內容時會遇到的最常見事項範例。在文字方塊中進行變更。您可以使用「預覽變更」標籤預覽變更。GitHub 了解 asciidoc 格式,並會提供變更的格式化預覽。

  5. 在頁面底部撰寫變更的簡潔說明,然後按一下「建議檔案變更」。這會將原始存放庫分岔到您自己的存放庫版本,並套用變更。

  6. 然後您會看到「比較變更」頁面 - 所有資訊都應自動填寫,而變更摘要會顯示在底部 - 這是再次檢視的時機。假設一切正確,您可以按一下「建立拉取要求」將變更建議回原始存放庫。然後您就能為拉取要求本身新增留言,然後按一下「建立拉取要求」。

提交大型變更

對於任何重大變更,先開啟 議題,並在花時間處理之前討論變更。

如果您要建立全新頁面或進行需要多次提交的重大變更,您可能會發現使用命令列工具會比較容易。

為較大的變更建立本地環境

  1. 分岔內容存放庫 https://github.com/clojure/clojure-site - 這會在您自己的使用者 ID 下建立網站內容版本。

  2. 在您的本地終端機中 git clone 分岔的存放庫,並 cd clojure-site

  3. git checkout -b <branchname> - 建立新分岔來處理您的變更。您會使用此分岔提交拉取要求。

  4. 在此分岔上進行一次或多次提交,修改或新增一個或多個檔案。請參閱下方關於如何本地建置和預覽變更的區段。編輯 頁面列出您在編輯此網站內容時會遇到的最常見事項範例。

  5. 使用 git push 將您的變更推送到分岔。

  6. 前往 https://github.com/username/clojure-site/tree/branchname。

  7. 按一下綠色按鈕「比較、檢閱並建立拉取要求」,並依照提示提交拉取要求。

要積極貢獻網站,讓您自己的分岔與此存放庫保持最新非常重要。執行此操作

  1. 將此存放庫新增到您的遠端網址:git remote add upstream https://github.com/clojure/clojure-site.git

  2. 在每次貢獻之前

    • 擷取上游內容:git fetch upstream

    • 移至您的主分支:git checkout master(如果您尚未在主分支中);

    • 將 HEAD 重設為已擷取的分支,清除主分支中所有未計畫的修改:git reset --hard upstream/master;以及

    • 建立一個新的分支,如上所述:git checkout -b <branchname>

建置和預覽變更

在進行較大的變更時,在本地建置網站會很有用。網站使用 JBake 建置。

若要 安裝 JBake 2.6.5

  1. curl -L -O https://dl.bintray.com/jbake/binary/jbake-2.6.5-bin.zip(或使用瀏覽器下載此檔案)

  2. unzip -o jbake-2.6.5-bin.zip

  3. 將 jbake-2.6.5-bin/bin 加入您的系統 PATH

若要建置網站

擷取內容

  1. git clone https://github.com/clojure/clojure-site.git(或您自己的分支)

  2. cd clojure-site

擷取並安裝目前的佈景主題資產(這些資產不太常變更,因此您不必每次都執行此步驟)

  1. curl -O https://clojure.dev.org.tw/clojuretheme.zip(或使用瀏覽器下載此檔案至 clojure-site 目錄)

  2. unzip -o clojuretheme.zip

產生網頁

  1. jbake -b - 這會在輸出目錄中建立靜態網站

  2. 若要檢視靜態檔案,請在您的瀏覽器中開啟 output/index

  3. 若要檢視即時預覽,請執行 jbake -s 並前往 https://127.0.0.1:8820/index

樣式和導覽變更

我們目前不尋求整體網站樣式、導覽或基礎架構的變更。該領域有正在進行的工作,將在不久的將來可見。

如果您在這些領域遇到問題,請開啟 問題,而不是提交拉取請求。

如何審查和部署貢獻

提交拉取請求後,貢獻將等待審查。

對於每個拉取請求,將由其中一位審閱者採取行動

  • 使用「已審閱」標籤標記註解。這表示審閱者核准變更,並要求編輯人員合併這些變更。

  • 在拉取請求中提出建議其他變更的註解。您可以在本機分支中使用進一步的提交來處理這些變更。

  • 關閉拉取請求,並在註解中說明變更不適當的原因。

謝謝!

感謝您的貢獻!

使用條款

版權所有 © 2019 Rich Hickey 及貢獻者

除非另有註明,否則此儲存庫中包含的所有文件都由 Rich Hickey 根據 Eclipse Public License v1.0 授權。