Skip to content

Latest commit

 

History

History
159 lines (93 loc) · 4.37 KB

File metadata and controls

159 lines (93 loc) · 4.37 KB

Contributing to CEH-Flow-Perception

参与 CEH-Flow-Perception 贡献指南

Thank you for your interest in improving this project.

感谢你对改进本项目的兴趣。

1. General Principle

1. 总体原则

We welcome contributions that improve stability, readability, reproducibility, performance, safety, or documentation quality.

我们欢迎能够提升稳定性、可读性、可复现性、性能、安全性或文档质量的贡献。

Please keep the project technically rigorous and practically testable.

请保持项目在技术上严谨、在工程上可测试。

2. Preferred Contribution Areas

2. 优先贡献方向

Preferred areas include:

优先方向包括:

  • field stability improvements

  • 场稳定性改进

  • adaptive tuning improvements

  • 自适应调参改进

  • camera input robustness

  • 摄像头输入鲁棒性改进

  • UI clarity for non-technical users

  • 面向非技术用户的界面清晰度改进

  • audit logging quality for technical users

  • 面向技术用户的审计日志质量改进

  • benchmark reproducibility

  • 基准测试可复现性改进

  • cross-platform build fixes

  • 跨平台构建修复

3. Pull Request Expectations

3. Pull Request 要求

Please keep pull requests focused.

请让每个 Pull Request 尽量聚焦。

A pull request should ideally solve one main problem at a time.

一个 Pull Request 最好一次只解决一个主要问题。

Please include: 请尽量附带:

  • what problem is being solved

  • 解决了什么问题

  • why the change is needed

  • 为什么需要这个改动

  • how the behavior changed

  • 行为发生了什么变化

  • screenshots or logs if UI or runtime behavior changed

  • 如果界面或运行时行为变化较大,请附带截图或日志

  • benchmark notes if performance is affected

  • 如果影响性能,请附带基准说明

4. Coding Style

4. 代码风格

Please prefer clarity over cleverness.

请优先保证清晰,而不是炫技。

Please avoid unnecessary renaming of established project concepts.

请避免无必要地重命名项目中已经稳定的核心概念。

Keep terminology consistent with the project vocabulary, such as conduct field, learn field, back-reaction, swarm, and field force.

请尽量保持与项目词汇一致,例如 conduct field、learn field、back-reaction、swarm、field force 等。

If Chinese UI text is changed, please also consider whether an English technical description is needed in documentation.

如果修改了中文界面文本,请同步考虑文档中是否需要补充英文技术说明。

5. Testing

5. 测试要求

Contributions affecting runtime logic should be tested as much as reasonably possible.

凡是影响运行逻辑的贡献,都应尽可能经过合理测试。

Please test at least one real camera path or one reproducible recorded scenario when possible.

在可能的情况下,请至少测试一个真实摄像头路径或一个可复现的录制场景。

If you change field update logic, please describe expected changes in:

如果你改动了场更新逻辑,请说明以下指标预期如何变化:

  • energy behavior

  • 场能行为

  • gradient behavior

  • 梯度行为

  • repulsion behavior

  • 排斥行为

  • agent movement behavior

  • 智能体运动行为

6. Legal and Licensing Reminder

6. 法律与许可提醒

By contributing to this project, you represent that you have the right to submit the contribution.

向本项目提交贡献,即表示你确认自己有权提交该贡献。

Unless explicitly agreed otherwise in writing, contributions are submitted under the same licensing framework used by this repository.

除非另有书面明确约定,否则贡献默认按照本仓库采用的同一许可框架提交。

Do not submit code, assets, diagrams, or text that you do not have the right to contribute.

请不要提交你无权贡献的代码、素材、图示或文本。

7. Respectful Collaboration

7. 尊重协作

Please discuss substantial architectural changes before implementing them.

对于重大架构变更,请尽量先讨论,再开始实现。

Please keep technical disagreement evidence-based and concrete.

技术分歧请尽量基于证据和具体事实讨论。

8. Contact

8. 联系方式

For larger collaboration or commercial integration proposals, contact:

如需更大规模合作或商业集成讨论,请联系:

陈恩华

15557000007

a106079595@qq.com