代码库创建与提交规范

1. 创建新的代码库 (Repository)

为了确保实验室科研成果的有效管理和协作开发，请遵循以下准则来创建新的代码库：

1.1 仓库必须私有，仅仓库成员可见。

1.2 命名规范

• 使用小写字母和连字符（-）命名代码库，避免使用空格或特殊字符。
• 名称应简洁且能准确反映项目内容。例如：medical-image-analysis, bio-signal-processing。

1.3 初始化设置

• 在创建代码库时，务必初始化 .gitignore 文件，选择适合项目的模板（如 Python）。
• 添加 README.md 文件，简要描述项目的背景、功能、安装步骤以及使用方法。
• 添加 LICENSE 文件，明确代码的开源许可协议（如 MIT、Apache 等）。

1.3 分支管理

• 主分支为 main 或 master，用于发布稳定版本。
• 开发分支为 develop，所有新功能开发应基于此分支。
• 功能分支命名建议以 feature/、bugfix/ 或 hotfix/ 开头，如 feature/image-segmentation。

2. 提交代码规范

良好的提交习惯有助于团队协作和历史追踪，请遵循以下规范：

2.1 提交信息格式

每次提交请使用清晰、有意义的提交信息，建议遵循以下格式：

常用类型 (type)：

• feat: 新增功能
• fix: 修复问题
• docs: 文档更新
• style: 格式调整（如缩进、空格）
• refactor: 代码重构
• test: 测试相关改动
• chore: 构建过程或辅助工具的变动

示例：

feat: add image segmentation module
fix: resolve memory leak in signal processing
docs: update README for installation guide

2.2 提交粒度

• 每次提交应只完成一个任务，避免一次提交多个不相关的改动。
• 遵循“小步快跑”的原则，频繁提交小改动，便于追踪和回滚。

2.3 Pull Request (PR) 要求

• 所有代码合并到主分支前必须通过 Pull Request 流程。
• PR 中需提供详细的描述，包括修改内容、解决的问题及测试结果。
• 至少需要一位团队成员进行代码审查并批准后方可合并。

3. 其他建议

3.1 文档维护

• 保持文档（如 README.md、docs/ 目录）与代码同步更新。
• 对于复杂模块，建议编写详细的注释和 API 文档。

3.2 版本控制

• 使用语义化版本号（SemVer），如 v1.0.0。
• 每个正式版本发布时应打上 Git Tag，并在 Release 页面说明更新内容。

3.3 协作与沟通

• 定期进行代码审查，确保代码质量。
• 如遇到问题，请及时反馈。

感谢您的配合，让我们共同打造高效、规范的科研代码管理体系！