Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

76 lines (53 loc) · 2.77 KB

Contributing

感谢你愿意为 Code Ark(代码方舟)做贡献。

Code Ark(代码方舟)是一个面向本地开发环境的 Docker Compose 配置集合。我们欢迎新的服务目录、文档改进、脚本优化和问题修复,但请尽量保持仓库的结构一致、配置清晰、可公开复现。

提交前建议

  • 先阅读根目录 README.md,确认现有服务矩阵和文档风格。
  • 尽量一类改动对应一个 PR,例如“新增一个服务”或“修正文档中的端口说明”。
  • 如果改动会影响端口、目录名称或默认配置,请同步更新相关 README。

新增服务目录的最低要求

新增一个服务目录时,请尽量满足以下约定:

  • 目录名称采用 <service>-start-local 风格。
  • 至少包含一个可直接运行的 docker-compose.yml。
  • 如果服务依赖环境变量,请提供 .env.example。
  • 如果服务需要数据库初始化、额外配置或脚本,请把这些文件放在服务目录内,并在 README 中说明用途。
  • 服务应尽量使用清晰可预期的端口映射,避免和仓库中已有服务冲突。

README 最低要求

每个服务目录的 README 至少应包含:

  • 服务简介
  • English Summary
  • 组件和端口说明
  • 前置条件
  • 快速启动命令
  • 配置说明
  • 数据持久化或清理方式
  • 常用命令
  • 返回根 README 的导航链接

请优先以仓库中的真实 docker-compose.yml、脚本和配置文件为准,不要在 README 中描述仓库并未提供的能力。

.env.example 约定

  • README 不要要求用户去查看他人的真实 .env。
  • 如果服务需要敏感值,请在 .env.example 中提供变量名和占位值。
  • 不要提交真实密码、token、API key 或其他敏感配置。
  • README 中应默认引导用户执行 cp .env.example .env,然后按本地环境修改。

端口与目录命名

  • 优先复用当前仓库的目录命名风格与端口策略。
  • 如果新增端口,请尽量避开本仓库已经占用的默认端口。
  • 某些目录保留了历史命名,例如 mysql-start-lcoal、rabbitmq-start-lcoal。除非有明确迁移计划,否则不要在无配套迁移说明的情况下直接重命名。

PR / Issue 规范

提交 Issue 时,建议包含:

  • 使用的服务目录
  • Docker 与 Docker Compose 版本
  • 操作系统
  • 复现步骤
  • 关键日志或报错信息

提交 PR 时,建议包含:

  • 改动目的
  • 影响范围
  • 是否更新 README
  • 是否引入新的端口、环境变量或初始化步骤

文档风格

  • 中文优先,必要时补充简短英文摘要。
  • 面向公开仓库编写,避免依赖本地私有环境知识。
  • 命令尽量保持可复制执行。
  • 不在 README 中暴露真实凭据。

感谢你的贡献。