此網站是一個關於 ClojureScript 程式語言及其廣大生態系統的開源內容儲存庫,託管於 https://clojurescript.dev.org.tw。
如果您想指出網站上的問題或提出新的頁面,您可以在 https://github.com/clojure/clojurescript-site/issues 上提交 GitHub issue。
如果您想做出貢獻(錯字、修改或新內容),您必須成為貢獻者並使用以下描述的流程
貢獻者在提交變更之前必須簽署 Clojure 貢獻者協議。 貢獻者協議 (CA) 賦予 Rich Hickey 和貢獻者共同的著作權權益:貢獻者保留著作權,同時也將這些權利授予 Rich Hickey 作為開源專案的發起人。
CA 源自 Oracle 貢獻者協議 (OCA),用於 OpenJDK、Netbeans 和 OpenSolaris 等專案。有一個很好的 OCA 常見問題回答許多問題。
通過執行 CA,貢獻者可以保護 ClojureScript 網站內容,並保護專案靈活適應社群不斷變化的需求。為了使 CA 有效,ClojureScript 專案必須獲得所有貢獻的轉讓。請仔細閱讀 CA,以完全了解其條款和條件。通過向 ClojureScript 貢獻原始碼或其他材料,您表示您已與 Rich Hickey 簽訂了關於此類貢獻的 CA。為了追蹤貢獻者,您了解您的全名和使用者名稱可能會張貼在可通過公開 URL 訪問的授權貢獻者列表網頁上。
要完成協議,請填寫並提交貢獻者協議(線上電子表單)。
請注意,如果您已經簽署了 Clojure 貢獻者協議,以向 ClojureScript 原始碼提供修補程式,則無需再次簽署,因為它是相同的協議。
小的變更可以直接在 GitHub 網頁介面中提出
導覽至您想要更新的 content/ 下的頁面 - URL 應與檔案基本名稱相符。例如,此檔案的內容位於 https://github.com/clojure/clojurescript-site/blob/master/content/community/contributing_site.adoc。
點擊編輯(鉛筆)圖示。
內容使用 asciidoc 格式編寫,這類似於 Markdown。 編輯頁面列出了您在此網站上編輯內容時會遇到最常見的事情的範例。在文字方塊中進行更改。您可以使用「預覽變更」標籤預覽您的變更。 GitHub 了解 asciidoc 格式,並將提供您的變更的格式化預覽。
在頁面底部寫下對變更的簡潔描述,然後點擊「提議檔案變更」。這會將原始儲存庫分叉到您自己的儲存庫版本中,並套用變更。
然後您會看到「比較變更」頁面 - 所有資訊都應該自動填寫,您的變更摘要將在底部 - 這是一個再次檢查它們的好時機。假設一切看起來都正確,您可以點擊「建立提取請求」將變更提議回原始儲存庫。然後您將能夠在提取請求本身中添加註解,然後點擊「建立提取請求」。
對於任何重大變更,**請**先開啟一個 issue,並在花時間進行更改之前討論。 |
如果您要建立一個全新的頁面或進行需要多次提交的重大變更,您可能會發現使用命令行工具更容易工作。
要建立用於處理較大變更的本機環境
分叉內容儲存庫 https://github.com/clojure/clojurescript-site - 這會在您自己的使用者 ID 下建立網站內容的版本。
在您的本機終端機中 git clone
分叉的儲存庫,並 cd clojurescript-site
。
git checkout -b <分支名稱>
- 建立一個新的分支來處理您的變更。您將使用此分支提交提取請求。
在此分支上進行一次或多次提交,修改或新增一個或多個檔案。請參閱下方關於如何在本地建置和預覽變更的部分。 編輯頁面列出了您在此網站上編輯內容時會遇到最常見的事情的範例。
使用 git push
將您的變更推送至分支。
前往 https://github.com/username/clojurescript-site/tree/branchname。
點擊綠色按鈕「比較、審閱和建立提取請求」,然後按照提示提交提取請求。
為了積極貢獻網站,重要的是讓您自己的分叉與此儲存庫保持最新。為此,請執行以下操作
將此儲存庫新增至您的遠端 URL:git remote add upstream https://github.com/clojure/clojurescript-site.git
。
在每次貢獻之前
提取上游的內容:git fetch upstream
;
移動到您的 master 分支:git checkout master
(以防您不在那裡);
通過將 HEAD 重置為提取的分支來清除 master 分支的任何未計劃的修改:git reset --hard upstream/master
;以及
如上所述建立一個新分支:git checkout -b <分支名稱>
在處理較大的變更時,在本機建置網站很有用。該網站是使用 JBake 建置的。
要 安裝 JBake 2.5.0-SNAPSHOT
curl -O http://cdn.cognitect.com/clojurescript.org/jbake-2.5.0-SNAPSHOT-bin.zip
(或使用您的瀏覽器下載此檔案)
unzip -o jbake-2.5.0-SNAPSHOT-bin.zip
將 jbake-2.5.0-SNAPSHOT/bin 新增至您的系統 PATH
要建置網站
擷取內容
git clone https://github.com/clojure/clojurescript-site.git
(或您自己的分叉)
cd clojurescript-site
擷取並安裝當前主題資產 (這些資產不會經常更改,因此您無需每次都執行此操作)
curl -O https://clojurescript.dev.org.tw/cljstheme.zip
(或使用您的瀏覽器將此檔案下載到 clojurescript-site 目錄)
unzip -o cljstheme.zip
產生頁面
請注意,
jbake
2.5.0 需要 Java 8。(它在 Java 9 下無法正常運行。)
jbake
- 這將在輸出目錄中建立靜態網站
要檢視靜態檔案,請在您的瀏覽器中開啟 output/index
要檢視即時預覽,請執行 jbake -s
並前往 https://127.0.0.1:8820/index
我們目前不尋求變更網站的整體樣式、導覽或基礎結構。該領域正在進行的工作將在不久的將來可見。
如果您在這些領域遇到問題,請開啟一個 issue,而不是提取請求。
提交提取請求後,貢獻將等待審查。
對於每個提取請求,一位或多位審查者將採取行動
使用「已審閱」標籤標記評論。這表示審查者批准變更,並要求編輯合併這些變更。
評論提取請求,建議其他變更。您可以使用本機分支上的其他提交來處理這些變更。
關閉提取請求,並附上評論說明變更為何不適當。
Copyright © 2015 Rich Hickey 和貢獻者
除非另有說明,否則此儲存庫中包含的所有文件均由 Rich Hickey 根據 Eclipse 公共許可證 v1.0 授權。