CONTRIBUTING_cn.md

中文 | English

贡献指南

感谢你有意参与 Accelerated Computing Notes！本仓库是面向 AI 基础设施与 GPU kernel 工程的社区知识库。

如何贡献

1. 修正错别字或失效链接 — 随时欢迎，直接提交 PR。

2. 新增内容 — 请先开 issue 讨论范围，再提交 PR。

3. 改进现有笔记 — 补全 TODO、增加图示、更新过时引用。

4. 分享基准测试或代码示例 — 实践案例非常受重视。

内容规范

结构

• 每个主题章节以 README.md 作为入口。

• 深度主题使用子目录（例如 FlashAttention/、DeepGemm/）。

• 图片放在对应章节下的 images/ 子目录中。

格式

• 标题、代码与技术术语使用 英文。

• 说明性文字可使用 中文 或 英文。

• 使用标准 Markdown。代码块请带语言标签。

• 行宽适中，便于在 diff 中阅读。

文件命名

• 章节入口使用 README.md（大写）。

• 其他文件使用小写加下划线（例如 code_review.md）。

• 目录名使用小写加连字符（例如 15-dsl-and-compiler/）。

代码示例

• 代码围栏需带语言标签（python、cuda、```c++）。

• 对非显而易见的逻辑添加简短注释。

• 改编代码时请注明来源仓库/论文。

Pull Request 流程

1. Fork 本仓库并创建功能分支。

2. 按上述规范修改。

3. 确认所有内部链接仍可用。

4. 提交 PR，并在描述中清楚说明改动内容与原因。

行为准则

请保持尊重与建设性。我们都在这里学习与分享加速计算相关知识。