From 3dd9790015aa2f3bd88bc61879a5c2eff6316be1 Mon Sep 17 00:00:00 2001
From: Lovegood <arvinlovegood@163.com>
Date: Mon, 10 Feb 2025 12:07:35 +0800
Subject: [PATCH] Create CONTRIBUTING.md

---
 CONTRIBUTING.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..8102797
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,79 @@
+# Contributing to [go-stock]
+
+感谢你对 [go-stock] 项目的兴趣并愿意贡献代码！本指南将帮助你了解如何为这个项目做出贡献。
+
+## 行为准则
+
+在参与这个项目时，请遵守我们的 [行为准则](./CODE_OF_CONDUCT.md)。我们致力于为所有贡献者提供一个友好、包容和尊重的环境。
+
+## 贡献类型
+
+### 报告问题
+如果你发现了一个 bug、有功能请求或者对项目有任何建议，请在项目的 [GitHub Issues](https://github.com/ArvinLovegood/go-stock/issues) 中创建一个新的 issue。在创建 issue 时，请提供尽可能多的信息，包括：
+- **问题描述**：清晰地描述你遇到的问题或建议的功能。
+- **重现步骤**：如果是 bug，请提供重现该问题的具体步骤。
+- **环境信息**：例如操作系统、编程语言版本等。
+- **相关日志或错误信息**：如果有的话，请附上相关的日志或错误信息。
+
+### 提交代码
+我们欢迎各种类型的代码贡献，包括修复 bug、添加新功能、改进文档等。请按照以下步骤提交你的代码：
+
+#### 1.  Fork 项目
+在 GitHub 上点击项目页面的 “Fork” 按钮，将项目复制到你自己的 GitHub 账户下。
+
+#### 2. 克隆项目到本地
+使用以下命令将你 fork 的项目克隆到本地：
+```bash
+git clone https://github.com/ArvinLovegood/go-stock.git
+cd go-stock
+```
+
+#### 3. 创建新分支
+在开始编写代码之前，创建一个新的分支来包含你的更改。建议使用一个描述性的分支名称，例如 `fix-bug-123` 或 `add-new-feature`。
+```bash
+git checkout -b 新分支名称
+```
+
+#### 4. 编写代码
+在新分支上进行你的代码更改。请确保你的代码遵循项目的编码风格和规范。
+
+#### 5. 测试代码
+在提交代码之前，请确保你的更改通过了项目的测试。如果项目没有测试，请考虑添加适当的测试。
+
+#### 6. 提交更改
+将你的更改提交到本地仓库，并提供一个清晰、简洁的提交信息。
+```bash
+git add.
+git commit -m "描述你的更改，例如：修复了 #123 号 bug"
+```
+
+#### 7. 同步上游仓库
+在推送代码之前，确保你的分支与上游仓库（原始项目）保持同步。
+```bash
+git remote add upstream https://github.com/ArvinLovegood/go-stock.git
+git fetch upstream
+git rebase upstream/main
+```
+
+#### 8. 推送更改
+将你的更改推送到你 fork 的 GitHub 仓库。
+```bash
+git push origin 新分支名称
+```
+
+#### 9. 创建 Pull Request
+在 GitHub 上，导航到你 fork 的项目页面，点击 “New pull request” 按钮。选择你刚刚推送的分支，并提供一个清晰的描述，说明你的更改内容和目的。然后提交 pull request。
+
+### 改进文档
+良好的文档对于项目的成功至关重要。如果你发现文档中有错误、不清楚的地方或者有可以改进的地方，请提交一个 issue 或者直接修改文档并提交 pull request。
+
+## 代码风格和规范
+请遵循项目的代码风格和规范。如果项目中没有明确的规范，请参考以下通用准则：
+- **代码格式**：使用一致的缩进、空格和换行符。
+- **注释**：添加适当的注释来解释代码的功能和逻辑。
+- **命名规范**：使用有意义的变量名、函数名和类名。
+
+## 许可证
+通过贡献代码，你同意你的贡献将根据项目的 [许可证](./LICENSE) 进行分发。
+
+再次感谢你对项目的贡献！如果你有任何问题或需要帮助，请随时在 issue 中提问。