|
1 | 1 | # Contributing to Go-Spring |
2 | 2 |
|
3 | | -首先,感谢你关注并支持 Go-Spring 项目! |
4 | | - |
5 | | -我们欢迎各种形式的贡献,包括但不限于 Issue 提交、文档完善、Bug 修复、功能开发等。请按照以下指引参与贡献: |
6 | | - |
7 | | -## 提交 Issue |
8 | | - |
9 | | -- 在提交前,请先搜索现有的 Issue,避免重复提交。 |
10 | | -- 请提供清晰的复现步骤、预期行为以及实际结果。 |
11 | | -- 如有错误日志或运行环境信息,请一并附上。 |
12 | | - |
13 | | -## 提交 Pull Request |
14 | | - |
15 | | -1. **Fork 仓库并创建新分支** |
16 | | - ```bash |
17 | | - git checkout -b feature/your-feature-name |
18 | | - ``` |
19 | | - |
20 | | -2. **保持一致的代码风格** |
21 | | - - 遵循 Go 官方代码规范(使用 `gofmt`、`golint`、`go vet`) |
22 | | - - 推荐使用 [`golangci-lint`](https://github.com/golangci/golangci-lint) 进行本地代码检查 |
23 | | - |
24 | | -3. **编写测试用例** |
25 | | - - 所有新功能必须配备单元测试 |
26 | | - - 使用 Go 内置的 `testing` 包,测试文件应命名为 `xxx_test.go` |
27 | | - |
28 | | -4. **更新相关文档(如有变更)** |
29 | | - |
30 | | -5. **提交并创建 Pull Request** |
31 | | - - 说明 PR 的目的、变更内容、测试情况等 |
32 | | - - 关联相关 Issue(如有) |
33 | | - |
34 | | -## 本地开发环境要求 |
35 | | - |
36 | | -- Go 版本:推荐使用最新版稳定版(如 `go1.21+`) |
37 | | -- 使用 Go Modules 进行依赖管理 |
38 | | -- 确保测试全部通过: |
39 | | - ```bash |
40 | | - go test ./... |
41 | | - ``` |
42 | | - |
43 | | -## 联系我们 |
44 | | - |
45 | | -如有疑问,欢迎通过 Issue 与我们联系,或参与项目的讨论区。 |
46 | | - |
47 | | -感谢你的贡献! |
48 | | - |
49 | | ---- |
50 | | - |
51 | | -# Contributing to Go-Spring |
52 | | - |
53 | 3 | First of all, thank you for your interest in and support of the Go-Spring project! |
54 | 4 |
|
55 | 5 | We welcome all kinds of contributions, including reporting issues, improving documentation, fixing bugs, and developing |
@@ -96,3 +46,53 @@ new features. Please follow the guidelines below to contribute: |
96 | 46 | If you have any questions, feel free to open an issue or join the discussion forum. |
97 | 47 |
|
98 | 48 | Thank you for contributing! |
| 49 | + |
| 50 | +--- |
| 51 | + |
| 52 | +# Contributing to Go-Spring |
| 53 | + |
| 54 | +首先,感谢你关注并支持 Go-Spring 项目! |
| 55 | + |
| 56 | +我们欢迎各种形式的贡献,包括但不限于 Issue 提交、文档完善、Bug 修复、功能开发等。请按照以下指引参与贡献: |
| 57 | + |
| 58 | +## 提交 Issue |
| 59 | + |
| 60 | +- 在提交前,请先搜索现有的 Issue,避免重复提交。 |
| 61 | +- 请提供清晰的复现步骤、预期行为以及实际结果。 |
| 62 | +- 如有错误日志或运行环境信息,请一并附上。 |
| 63 | + |
| 64 | +## 提交 Pull Request |
| 65 | + |
| 66 | +1. **Fork 仓库并创建新分支** |
| 67 | + ```bash |
| 68 | + git checkout -b feature/your-feature-name |
| 69 | + ``` |
| 70 | + |
| 71 | +2. **保持一致的代码风格** |
| 72 | + - 遵循 Go 官方代码规范(使用 `gofmt`、`golint`、`go vet`) |
| 73 | + - 推荐使用 [`golangci-lint`](https://github.com/golangci/golangci-lint) 进行本地代码检查 |
| 74 | + |
| 75 | +3. **编写测试用例** |
| 76 | + - 所有新功能必须配备单元测试 |
| 77 | + - 使用 Go 内置的 `testing` 包,测试文件应命名为 `xxx_test.go` |
| 78 | + |
| 79 | +4. **更新相关文档(如有变更)** |
| 80 | + |
| 81 | +5. **提交并创建 Pull Request** |
| 82 | + - 说明 PR 的目的、变更内容、测试情况等 |
| 83 | + - 关联相关 Issue(如有) |
| 84 | + |
| 85 | +## 本地开发环境要求 |
| 86 | + |
| 87 | +- Go 版本:推荐使用最新版稳定版(如 `go1.21+`) |
| 88 | +- 使用 Go Modules 进行依赖管理 |
| 89 | +- 确保测试全部通过: |
| 90 | + ```bash |
| 91 | + go test ./... |
| 92 | + ``` |
| 93 | + |
| 94 | +## 联系我们 |
| 95 | + |
| 96 | +如有疑问,欢迎通过 Issue 与我们联系,或参与项目的讨论区。 |
| 97 | + |
| 98 | +感谢你的贡献! |
0 commit comments