CONTRIBUTING.md

贡献者指南

欢迎反馈、bug报告和拉取请求，可点击issue 提交.

如果你是第一次进行GitHub的协作，可参阅： 协同开发流程

注意事项

• 如果你的变更中新增或者减少了配置，那么需要注意有这么几个地方需要同步调整：

  • config.go
  • config.example.yml
  • docker-compose.yml
  • README.md
    • docker 启动命令中要添加。
    • 配置文件说明要添加。

  一定要检查这几个地方，而且注意务必加好注释，否则将会影响用户升级体验新功能。

• 关于配置管理还有一个很重要的点在于，config.example.yml中的配置务必配置为最大权限，以免出现用户首次部署就无法走到正常逻辑的情况。

• 请务必检查你的提交，是否包含secret，api_key之类的信息，如果要贴示例，注意数据脱敏。

• 如果新增了功能性的模板，则务必在使用指南中添加对应说明文档。