跳到主要内容

参与其中

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 和 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 网站提出快速编辑建议——例如，此链接将直接带您进入此网页的基于 Web 的编辑器。通常，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 组织等）。