贡献指南

前置知识

• 使用中文阅读、沟通、表达的能力
• Github 和 Git 的基础使用方法
• Markdown 基础语法

贡献方式

本项目在 Github 上维护，基于 Github Pages 部署，如果希望参与贡献，欢迎直接提出 PR/Issue；请注意 项目仓库 为 Github 的公开仓库，即任何人都能查询到每个文件每次的作者、编辑者、编辑内容，如果对个人隐私等方面有顾虑，可以考虑开小号活动。

以任何形式参与贡献即代表您同意他人在满足 CC-BY-SA-4.0 license 协议要求的前提下使用您创作的内容。

项目结构可以查阅 MkDocs 和 Material for MkDocs 文档。

页面使用 Markdown 格式，支持 KaTeX 数学公式显示。

为了便于贡献者熟悉 Wiki 系统，本站新增了 沙盒 板块供测试 Markdown 语法等元素。

贡献要求

通用要求

• 请不要在本项目发布违反中华人民共和国法律或容易引起不适的内容。
• 尊重他人，文明用语。
• 如引用或转载他人作品，请留意其是否有转载限制，避免造成不必要的纠纷。
• 避免过度谈及他人情况或暴露个人信息。

语言要求

• 无特殊理由，所有社区活动和编辑使用中文或英文进行。
• 其中对于 Wiki 各页面展示的内容，一般应当使用中文编写。
• 对于 Github 平台上的讨论（如 Pull Request 和 Issue 标题、正文及评论），母语为中文或英文的贡献者建议使用本人母语，其他贡献者可选择中文、英文中自己更熟悉的语言。
• 对于 Git commit 信息，可以自行选择使用中文或英文。
• 引用其他语言的站内外资料，或是根据实际情况更适合使用其他语言的，可以使用相应语言。

大语言模型(LLM)工具使用要求

• 页面代码、框架部分的维护或更新，对于 LLM 工具使用没有特殊要求。
• Wiki 内容维护或更新：
• • 允许使用 LLM 工具进行资料检索、Markdown 格式排版和检查，对此没有特殊要求。
• • 对于其他使用场景（包括机器翻译），您应当标注贡献内容（或其一部分）由 LLM 工具完成（包括但不限于 Commit 信息、Issue 正文内标注等方式）。
• • 对于部分 LLM 生成内容，我们可能会另外进行事实核验或重写。

本地测试方法

环境要求：Python、pip

测试方式：在项目根目录下执行（可以使用 uv 等工具新建一个虚拟环境）pip install -r requirements.txt 安装依赖项；

安装完成后在项目根目录执行 mkdocs serve 打开终端输出中的链接（如 http://127.0.0.1:8000/）查看效果。

建议在较大规模或涉及页面代码、框架的改动后在本地按上述方法进行测试。

加入 AFOIer 维护团队

如果有意愿深度参与项目维护，希望能够承担以下一项或多项任务，可以加入团队：

• 审核并合入 Pull Request
• 处理 Issues
• 编辑、整理投稿
• 升级、维护、二次开发 MkDocs 及其组件，以更适配本项目的需求
• 处理用户反馈、侵权投诉等事项
• 发挥创意，建设更好的 Wiki 站点

如果有意向参与维护工作，请提交一条单独的 Issue 需要包含个人常用 id、联系方式(优先 QQ)、曾经在本项目的贡献（如有）、后续的工作规划等。我们也会主动邀请部分选手或其他相关人士参与工作。