Skip to content

Latest commit

 

History

History
99 lines (80 loc) · 7.25 KB

README.md

File metadata and controls

99 lines (80 loc) · 7.25 KB

《自由知識協作平台》主題範本

快速創建風格一致的《自由知識協作平台》主題

https://gitlab.com/libre-knowledge/gitlab-organization-templates/subject-template
GitLab CI 持續整合流程狀態標章 「檢查專案中的潛在問題」GitHub Actions 作業流程狀態標章 pre-commit REUSE 規範遵從狀態標章

使用說明

本章節說明如何使用這個主題範本創建新的《自由知識協作平台》主題：

  1. 確保已將自由知識協作平台 Libre Knowledge Collaboration Platform · GitLab 專案的 Git 版控庫拓製至本地，且已拉取當前最新的修訂版

  2. 開啟自由知識協作平台 Libre Knowledge Collaboration Platform · GitLab 頁面

  3. 點擊上側的「New project」藍色按鈕建立新的專案（目前本專案不支持使用 GitLab 的子群組架構，請一律將專案創建在最上層群組中）

    • 「Project name」欄位填入適當的主題標題（中文 + 英文）
    • 「Project slug」欄位填入適當的主題識別名稱（可以採用比較常見的英文縮寫）
    • 「Project deployment target (optional)」欄位下拉式選單選擇「Registry (package or container)」
    • 「Visibility Level」選擇「Public」
    • 「Project Configuration」區塊勾選「Initialize repository with a README」

  4. 點擊新專案頁面左側欄的 Settings > General 選項開啟 General Settings 設定頁面，進行下列設定：

    • Topics
      • 自由知識協作平台 Libre Knowledge Collaboration Platform
      • 自由知識協作平台主題 L.K.C.P. Topics
    • Project description 欄位輸入主題適當的文字描述

  5. 回到專案主頁面，點擊頁面右側的藍色「Clone」按鈕以獲取 Git 版控庫的拓製(clone)地址

  6. 於本地啟動一個文字終端應用

  7. 切換作業目錄至要放置該主題的「自由知識協作平台」目錄

  8. 執行下列命令將主題專案的 Git 版控庫以 Git 子模組的形式新增至本地先前已拓製到本地的「自由知識協作平台」：

    git submodule add \
    --name '_主題中文名稱_ _主題英文名稱_' \'
    https://gitlab.com/libre-knowledge/_主題識別名稱_.git \
    '/path/to/自由知識協作平台 Libre Knowledge Collaboration Platform/_親主題路徑（如果有）_/_主題中文名稱_ _主題英文名稱_'

  9. 編輯「自由知識協作平台 Libre Knowledge Collaboration Platform」主版控庫的 .gitmodules 文件，合併新主題子模組下列 Git 子模組配置：

    [submodule "_主題中文名稱_ _主題英文名稱_"]
    ignore = dirty

  10. 以下列修訂版提交訊息將「自由知識協作平台 Libre Knowledge Collaboration Platform」主版控庫的變更提交為一新修訂版：

    chore: 新增「_主題中文名稱_ _主題英文名稱_」主題

  11. 切換作業目錄至「自由知識協作平台」主目錄

  12. 執行下列命令將變更推送到遠端版控庫：

    git push

  13. 將本專案除下列以外專案文件複製到新的主題專案中：

    • README.md
    • .git
    • .markdownlint.yml

  14. 編輯子模組專案 real.README.md 主題說明文件模板，將 _佔位字_ 替換為適當之內容（別忘了替換 libre-knowledge/_專案ID_），並移除未使用之（待補）章節

  15. 用 real.markdownlint.yml Markdownlint 配置文件替換掉 .markdownlint.yml 本專案專屬的 Markdownlint 配置文件

  16. 將「real.gitattributes Git 路徑屬性配置文件」更名為「.gitattributes」

  17. 替換 .reuse/dep5 REUSE DEP5 機器可讀著作權宣告文件文件中的 Upstream-Name（替換為 主題名稱）欄位、 Upstream-Contact（替換為該主題專案議題追蹤系統的網頁標題與網址）欄位跟 Source（替換為專案網址）欄位

  18. 將 real.README.md 主題說明文件模板 替換掉 README.md 本專案說明文件

  19. 將變更提交為新修訂版（參考提交標題： docs: 撰寫主題說明文件雛型）

  20. 將本地變更推送到遠端版控庫

  21. 回到「自由知識協作平台 Libre Knowledge Collaboration Platform」主版控庫以下列修訂版提交訊息將新主題專案子模組的變更的提交為新修訂版：

    chore: 引入新版本的「_主題中文名稱_ _主題英文名稱_」主題

  22. 執行下列命令將變更推送到遠端版控庫：

    git push

參考資料

本章節列舉開發本專案期間所參考的第三方資料：