贡献指南
2025/5/14大约 3 分钟社区与贡献PRBug
sponge 是一个开源项目,非常欢迎您的贡献!无论是提交 Bug 报告、改进文档、修复 Bug 还是贡献新功能,您的参与都将使 sponge 变得更好。请遵循以下指南:
报告 Bug
如果您在使用 sponge 过程中遇到了 Bug,请通过 GitHub Issues 提交。一个好的 Bug 报告应包含以下信息:
- 您使用的 sponge 框架版本。
- 您的 Go 版本和操作系统。
- 详细的 Bug 复现步骤。
- 期望的结果是什么?
- 实际发生的结果是什么?
- 相关的错误日志或堆栈信息(请使用代码块格式化)。
- 如果可能,提供一个最小的可复现示例项目。
在提交之前,请先搜索现有的 Issues,看看是否已经有人报告过类似的问题。
提交 Pull Request
贡献代码的流程如下:
- Fork sponge 仓库到您的 GitHub 账户。
- 将您的 Fork 克隆到本地。
- 创建新的特性分支 (
git checkout -b feature/your-feature-name
或bugfix/your-bugfix-name
)。 - 在新的分支上编写代码。请确保您的代码风格符合项目规范,执行命令
make ci-lint
进行代码风格检查。 - 编写相应的测试用例,并确保所有测试通过 (
go test ./...
)。 - 提交您的更改 (
git commit -m "feat: add new feature"
或fix: fix bug #XYZ"
)。请使用清晰的 Commit 信息。 - 将您的本地分支推送到您的 Fork 仓库 (
git push origin feature/your-feature-name
)。 - 在 GitHub 上打开您的 Fork 仓库页面,创建一个 Pull Request (PR) 到主仓库的
main
(或develop
,具体取决于项目分支策略) 分支。 - 在 PR 描述中清晰地说明您的更改内容、解决了什么问题或添加了什么功能。如果关联了 Issue,请在描述中提及 (例如 "Fixes #XYZ" 或 "Resolves #XYZ")。
- 维护者会对您的 PR 进行 Review,并可能提出修改建议。请积极配合完成修改。
开发流程
开发流程如下:
- 在 GitHub Issues 中找到您想解决的问题或提出的新功能。如果您要提出新功能,请先通过微信、Issue 或 Discussions 讨论可行性。
- 与项目维护者沟通,确保您的方案与项目方向一致。
- 按照
提交 Pull Request
的步骤进行代码开发、测试和提交。 - 参与 PR Review 过程,完善代码。
- 一旦 PR 被批准并合并,您的贡献就正式成为项目的一部分了!