Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.87 KB

File metadata and controls

47 lines (33 loc) · 1.87 KB

Contributing Guide

感谢你愿意改进 Dev_cpp。本仓库的定位是 C/C++ 学习过程记录,因此贡献重点是让已有学习内容更清晰、更可靠、更容易复现。

适合提交的内容

  • 修复编译错误、边界条件错误或明显的未定义行为。
  • 给已有练习补充题目背景、输入输出样例、关键思路和复杂度分析。
  • 改进目录 README、运行指南、学习路线等文档。
  • 在保留原文件可追溯性的前提下,补充更清晰的实现版本。
  • 添加轻量级脚本或检查方式,帮助验证代码能否编译。

不建议提交的内容

  • 大规模格式化全部历史源码但没有实质说明。
  • 删除原始练习文件或覆盖学习痕迹。
  • 直接复制教材、课程讲义或第三方文章的大段内容。
  • 把仓库改造成与学习分享无关的通用框架。

提交流程

  1. Fork 仓库并创建新分支。
  2. 保持改动聚焦,一个 pull request 解决一个清晰问题。
  3. 如果修改代码,请说明使用的编译命令和运行结果。
  4. 如果修改文档,请检查链接和目录名称是否准确。
  5. 提交 pull request,并简要说明改动目的、影响范围和验证方式。

编码建议

  • 优先使用标准 C++,避免不必要的平台专有 API。
  • 新增代码建议使用 -std=c++17 能够编译通过。
  • 对于需要文件输入输出的程序,在 README 或代码注释中说明所需文件。
  • 保留学习型代码的上下文,但修复会误导读者的明显错误。

Commit Message 建议

推荐使用简洁、明确的提交信息,例如:

docs: add running guide
fix: correct stack boundary check
refactor: clarify linked list insertion demo

License

提交到本仓库的原创代码和文档默认同意按 MIT License 发布。第三方资料、教材题目和课程材料仍遵循其原始许可。