贡献指南与开放任务
贡献指南概述
若您希望将教程收录至本书，可通过以下方式提交：
若您熟悉 GitHub 操作，可点击桌面端网页右侧的“编辑此页”按钮进入项目编辑。本项目采用 Markdown 语法配合 GitBook 平台，易于上手（具体操作详见项目 WiKi）。
若上述方式存在困难，您也可发送 PDF、Word 或 TXT 格式的文档至电子邮箱
yklaxds@gmail.com（我们将在 3 个工作日内回复。如果没有收到回复，请更换邮箱再次发送或提交 issue）。如果有视频教程，建议上传至各大云盘并提供分享链接。
本书现收录以下类型的内容：
一切与 FreeBSD 相关及各种体系架构的教程。您既可以扩充现有教程，也可以创建新的章节。
下方的 ToDo 列表或 GitHub Project 中的任务。
您也可以在文学故事章节分享您与 BSD 的故事及个人心得体会。
基本原则与方法论
基本原则
内容应尽可能详尽且基础，勿假定读者具备任何使用背景
介绍大型软件（如 IDE、Java）时，请注明软件版本号
引用应注重权威性、时效性与准确性。优先采用原始文献，次选二手文献，避免使用三手文献
引用其他网站内容时，请核实其内容是否真实可信，尽量查阅一手来源而非直接引用网站内容
请提交至 main 分支
请避免学术不端行为，参见：高等学校预防与处理学术不端行为办法[EB/OL]. [2026-03-26]. https://www.gov.cn/zhengce/2016-07/19/content_5713390.htm （AIGC 相关规定除外）
请遵守 FreeBSD 中文社区行为规范
所有 AIGC（AI-Generated Content，人工智能生成内容）必须经过人工二次确认，核实其原始出处与来源的可靠性，不得直接提交。但纯粹翻译可作为例外绕过本规定。任何人对所提交内容自行负责，无论其是否由 AIGC 生成
使之成为“一本书”，而不仅是字典或手册
若某一技术在最新版本中已移除，应及时移除其在本书中的对应内容
使全书语气温和而坚定
尽量减少原文引用，重写各章节内容并删除冗余部分
实现 BSD 中文文档协作方式的现代化与简化：
自动化（CI 检查、预览、生成 HTML/PDF）
仅使用最基础的 Markdown 语法，避免复杂扩展和繁琐流程
技术与选材应与时俱进，确保内容的现代化
严格验证每一部分内容：
参考文献：不仅要求来源可查，更要求来源可信
原理性内容：
追溯至具体的 FreeBSD 源代码文件、提交记录或函数
明确引用相关标准、规范或法律文件
分析其设计哲学与开发思路
操作性内容：应在 FreeBSD 环境中亲自测试，确保可复现
审视原作者的开发哲学与理念，评价其合理性，并尝试简单参与相关项目
指出并修正上游官方手册中的错误或过时内容
生成英文版本
细则
非拉丁字符与拉丁字符之间应添加空格（中英文/数字之间应有一个半角空格），许多 Markdown 格式化工具可自动处理
不应使用
sudo而应使用#代替，除非是特殊情况（如讲解如何使用sudo本身）；普通用户权限请使用$表示安装软件时，请提供 pkg（FreeBSD 的二进制包管理器，用于安装、更新和管理预编译软件包，提供依赖关系解析和版本管理功能）或 Ports 两种方法，除非极不建议使用 pkg（如特定内核模块等）
请注意版权问题。引用内容或受到启发时，请备注文章链接出处，必要时可使用互联网档案馆快照保存
编辑时请尽量以最新的 FreeBSD RELEASE（FreeBSD 的正式发布版本，经过充分测试和稳定化，适合生产环境使用，每个 RELEASE 版本均有长期支持周期）为基准，绝对避免出现
pkg_add等过时内容。如有必要，必须注明相关版本编写工作会跟随每个 FreeBSD 大版本持续迭代更新
若因各种原因无法立即验证所写内容的正确性，请编辑者添加“警告：以下内容为理论，未经实际测试，仅供参考，如可使用请提交 issue 以移除本标签。”的提示标签来区分
不应在文学故事章节删减除错别字和排版以外的内容
请勿使用 Gitee 等境内无法确保信息安全与数据稳定的平台（此类平台无法保证文件的长期可访问性，不适合存放需长期归档的内容，未来存在无法获取文件的重大风险）
修改错别字时，请务必确认其确为错别字，可参考《现代汉语词典》第 7 版等资料佐证
实用附录
如何使用 Git 拉取本项目
技巧
您完全可以通过 GitHub 在线完成所有提交。
本项目体积较大，使用 Git 拉取时可能导致缓冲区溢出，可通过修改 Git 配置文件来扩大缓冲区。
以下是一个可用的 ~/.gitconfig（在 Windows 系统中的位置为 C:\Users\你的用户名\.gitconfig）的文件示例：
名词解释：
autocrlf：配置 Git 自动处理（转换）行结束符的默认行为。参见：配置 Git 处理行结束符 - GitHub Docs[EB/OL]. [2026-03-26]. https://docs.github.com/zh/get-started/git-basics/configuring-git-to-handle-line-endings.signingkey：指设置带签名提交时默认使用的签名密钥。signingkey 既可指 GPG Key，也可以指 SSH Key。自 Git 2.34 起，Git 支持了 SSH 签名验证功能。参见：关于提交签名验证 - GitHub Docs[EB/OL]. [2026-03-26]. https://docs.github.com/zh/authentication/managing-commit-signature-verification/about-commit-signature-verification.
拉取命令：
附录：Windows Git 配置示例
故障排除
致命错误：无法访问 'https://github.com/FreeBSD-Ask/FreeBSD-Ask/': Recv failure: 连接被对方重置
请尝试拉取项目 https://github.com/FreeBSD-Ask/LDWG。
若报错类似，说明您的网络存在问题，请使用代理。
项目简介
本项目主要托管在 GitBook（即 https://book.bsdcn.org）；
https://docs.bsdcn.org 由社区自行构建，docs 网站本身的贡献指南参见：FreeBSD 从入门到跑路 VitePress 镜像项目[EB/OL]. [2026-03-26]. https://github.com/FreeBSD-Ask/FreeBSD-Ask.github.io/blob/main/README.md。
技巧
若您仅想贡献内容本身，尚无改进 docs 网站浏览体验与构建优化等意向，则仅需阅读本文即可。
项目结构概览
如何新建章节
自行操作时参见操作实例 Commit 6023cc8[EB/OL]. [2026-03-26]. https://github.com/FreeBSD-Ask/FreeBSD-Ask/commit/6023cc8d58f3a1b9849ff11fa63bf3980177c370 和下方 SUMMARY.md 结构说明。
如果有困难可发邮件联系 ykla 协助操作。
SUMMARY.md 目录结构
可以看到，SUMMARY.md 在形式上就是普通的 Markdown 文档，并无特殊支持。
但有一些注意事项：
第一行
# Table of contents绝对不允许变更，否则 GitBook 将无法识别，导致失去同步。要求格式应为
* [2.2 使用 bsdinstall 开始安装](di-2-zhang-an-zhuang-freebsd/di-2.2-jie-start-install.md)，不允许出现* [2.2 使用 bsdinstall 开始安装](di-3-zhang-ni-hao/di-2.2-jie-start-install.md)这种情况，即目录结构与文件放置位置必须一致（不一致虽不会报错，但本项目要求保持一致）。通过
sync-headers.yml，将自动同步SUMMARY.md中的章节标题到具体的 Markdown 文件中。因此如果需要修改di-2.2-jie-start-install.md的一级标题# 2.2 使用 bsdinstall 开始安装，必须仅修改SUMMARY.md中的2.2 使用 bsdinstall 开始安装，否则会被sync-headers.yml覆盖。二者不一致时，若提交时未触发脚本构建，则 GitBook 将以SUMMARY.md中的目录为准。
预览页面
您提交 PR 时，系统会自动生成预览网站。
实际上，所有提交都有对应的网站版本：
您可通过该链接获取当前 PR 的实际显示样式：
且每次 push 都会自动更新：
开放任务
所有任务的排序均为随机，无优先级之分，您可选择感兴趣的任务参与。
开源社区
维护百度百科、维基百科相关条目
如增补修订各 BSD 中文条目。
帮助修订 USTC 镜像脚本
FreeBSD ToDo
不再需要 的内容（请 不要 撰写下列条目）：
Just for fun（可有可无）
需要重写 的内容（请撰写这些内容）：
参见：Projects[EB/OL]. [2026-03-26]. https://github.com/FreeBSD-Ask/FreeBSD-Ask/projects。
最后更新于