贡献指南

如何为 WebGPU 粒子流体仿真项目做贡献。

适合提交的改动

优先提交这类改动：

• 提升正确性或稳定性；
• 简化代码或文档；
• 改善性能或项目展示质量；
• 降低后续维护成本。

除非收益明确，否则避免继续扩张功能范围。

工作流

1. Fork 并克隆仓库。
2. 创建聚焦的分支。
3. 进行成组且易审阅的修改。
4. 运行 npm run verify。
5. 提交带清晰说明的 Pull Request。

本地准备

git clone https://github.com/YOUR_USERNAME/particle-fluid-sim.git
cd particle-fluid-sim
npm install

验证门

高影响改动提交前请运行完整质量门：

npm run verify

其中包括：

npm run lint
npm run typecheck
npm run test:coverage
npm run build

文档规则

• 文档必须与实际项目结构保持一致。
• 遇到重复或陈旧内容时，优先删除或合并，而不是继续叠加解释。
• GitHub Pages 只保留文档与在线演示，不承载变更日志。
• 根目录 CHANGELOG.md 是唯一变更日志。

Pull Request 检查清单

• [ ] 代码编译通过（npm run typecheck）
• [ ] 代码检查通过（npm run lint）
• [ ] 测试通过（npm run test:coverage）
• [ ] 构建成功（npm run build）
• [ ] 若行为或结构变化，相关文档已同步更新

获取帮助

• 问题： GitHub Issues
• 讨论： GitHub Discussions