跳到主要內容

參與貢獻

conda-forge 是一個社群驅動的跨平台套件專案，仰賴志工來維護與改進。

我們鼓勵您為 conda-forge 貢獻。您可以透過以下幾種方式參與

改進網站​

conda-forge 網站的版本控制在 GitHub 上的 conda-forge.github.io 儲存庫中。它使用 Docusaurus 建置。

網站儲存庫結構​

MD、MDX 與 JSX

雖然大部分內容以 Docusaurus 的 Markdown（*.md 檔案）撰寫，但某些特定頁面和章節包含動態區塊（*.mdx 檔案）或直接是 JSX 檔案（*.jsx 檔案）。這讓您可以在同一個文件中混合使用 Markdown 和 JavaScript/React，取決於檔案副檔名。不過，在 MDX 模式下，解析器會更嚴格。請參閱 Docusaurus 的「MDX and React」文件以了解更多資訊。

文件與社群​

  • 這兩個章節使用 plugin-content-docs。
  • 「文件」章節對應於 /docs 目錄。大部分頁面使用一般 Markdown（*.md），但有些是包含 JavaScript 的動態頁面（*.mdx）。
  • 「社群」章節來自 /community 目錄。

新聞與部落格​

  • 這兩個章節使用 plugin-content-blog。
  • 「新聞」章節來自 /news 目錄。它被視為我們基礎架構和套件重要變更的變更日誌。
  • 「部落格」章節對應於 /blog 目錄。它通常討論來自擴展生態系統的重要更新。

獨立頁面與章節​

  • 這些章節依賴 plugin-content-pages。
  • 它們可以是簡單的 Markdown 頁面，或是更精緻的 React 應用程式。
  • 可以在 /src/pages 下找到它們。MDX 和 JSX 頁面通常會呼叫在 /src/components 中定義的元件。

直接透過 Github 編輯文件​

如果您有 GitHub 帳號，可以直接透過 GitHub 網站提出快速編輯建議——例如，這個連結會直接帶您到這個網頁的線上編輯器。一般來說，GitHub 瀏覽器中每個頁面對應的檔案，在其右上角都有一個小鉛筆圖示，讓您可以開啟編輯。

在本機編輯文件​

我們很高興得知您想要為 conda-forge 文件貢獻。如果您是 conda-forge 社群的新手，請依照以下步驟進行您的首次貢獻

  1. Fork conda-forge.github.io 儲存庫。
  2. 將這個 Fork 複製到您的本機
    git clone https://github.com/<your-username>/conda-forge.github.io.git
    cd conda-forge.github.io
  3. 建立一個從 main 分支衍生的新分支來進行您的工作
    git checkout -b <new-branch-name>
  4. 執行以下指令
    conda env create -f ./.ci_scripts/environment.yml
    conda activate conda-forge-docs
  5. 在撰寫新文件時，您可以使用即時預覽模式，透過
    • npm install 以確保 node_modules 是最新的
    • npm run start 以啟動即時預覽。每次儲存檔案時，變更都會立即反映。
  6. 準備就緒後，您也可以使用以下指令檢查生產版本的樣子
    .ci_scripts/update_docs
    python -m http.server --directory build/
  7. 新增並提交您的變更
    git add .
    git commit -m "your commit message"
  8. 提交一個 Pull Request 到主要儲存庫，以提出您的變更。CI 管道將會在 Netlify 上包含 PR 預覽。

貢獻愉快！

寫作指南​

在您開始貢獻之前，應該記住一些基本的寫作指南

  1. 識別您的受眾並了解他們的技能水平。
  2. 使技術語言與受眾的技能水平熟練度相符。
  3. 盡量保持簡潔。如果您必須使用大量複雜術語，請提供關鍵術語詞彙表。
  4. 直接將受眾稱為使用者。
  5. 在提及動作時，使用動詞的「命令」形式：「從選單中選擇一個選項並按下 Enter。」
  6. 對於參考資料，請提供相關內容的連結。
  7. 使用標題和項目符號，這會使內容更容易閱讀。
  8. 避免含糊不清的標題。標題應包含頁面主題的清晰描述。
  9. 檢查您的拼字和文法。
  10. conda-forge 應始終以小寫、連字符且不帶反引號的方式拼寫。只有在用作識別符時才應使用反引號（例如 Anaconda.org 頻道、Github 組織等）。