Skip to content

Latest commit

 

History

History
27 lines (17 loc) · 1.58 KB

README.md

File metadata and controls

27 lines (17 loc) · 1.58 KB

项目创建与代码管理规范

一、项目结构

在仓库的project文件夹下,每个人应创建自己的子文件夹,子文件夹名称应采用英文命名,并保持简洁。例如:user123

在子文件夹内,存放所有与该项目相关的代码文件。

二、代码文件命名规范

  • 文件名只允许使用小写字母、数字和下划线,不允许出现中文、空格和其他特殊字符。
  • 文件名应简洁明了,能够准确反映文件内容或功能。
  • 对于源代码文件,建议使用.c.cpp作为后缀。

三、代码提交与合并请求(PR)

  • 强烈推荐使用Git进行版本控制,并按照Git的规范进行代码提交。
  • 当完成一段功能或修复一个bug后,应先在本地进行测试,确保无误后,再通过Git提交到远程仓库。
  • 提交信息应清晰描述本次提交的内容,包括解决了什么问题、新增了什么功能等。
  • 合并请求(PR)是向主仓库提交代码的方式。当你的代码通过本地测试并准备提交到主仓库时,应创建一个PR。在PR中,应详细描述你所做的更改和原因。
  • 不推荐直接在Gitee上操作然后发出PR,因为这样可能导致版本混乱或代码冲突。

遵循上述规范,不仅可以保持仓库的整洁,还可以提高团队协作的效率。希望每位成员都能遵守这些规则,共同维护好我们的代码仓库。

贡献指南

📖 如果你有兴趣贡献项目或发现了错误,请参考我们的 贡献指南