You are reading documentation for bouine v0.4.x — not the latest version. View latest →

贡献

感谢您改进 bouine。本项目重视准确性、性能和运维清晰度。

页面

  • 代码指南 — 包地图和适合的新手任务。
  • 安全 — 漏洞报告和加固说明。

前提条件

  • Go 1.26+
  • pre-commitpip install pre-commitbrew install pre-commit
  • Docker(用于集成测试)

设置

git clone https://github.com/bouine-cache/bouine.git
cd bouine
make hooks
make all

工作流程

  1. 定位 — 阅读 PLAN.md 和相关包文档。
  2. 规划 — 在写代码前先确定测试。
  3. 实现 — 最小的有用改动。
  4. 验证make all;如果触及 L1–L6 则 make bench
  5. 文档 — 行为变更时更新运行手册或配置文档。

提交格式

feat(cache): add negative caching for 404 responses
fix(cluster): retry join until actual peers discovered
docs(runbook): document cluster join retry

允许的前缀:featfixchoredocsrefactortestperfbuildci

PR 检查清单

  • pre-commit run --all-files 通过
  • make all 通过
  • 添加或更新测试
  • 缓存变更无 cache-tests 回归
  • 热路径变更无基准测试回归
  • 无密钥、token 或生产主机名