From bf432c0f44fe3615802d09bda0f60bd814005a0e Mon Sep 17 00:00:00 2001
From: aoshiguchen <1052045476@qq.com>
Date: Wed, 29 Mar 2023 00:04:26 +0800
Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E"=E5=A6=82=E4=BD=95=E8=B4=A1?=
 =?UTF-8?q?=E7=8C=AE"=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/如何贡献.MD | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 docs/如何贡献.MD

diff --git a/docs/如何贡献.MD b/docs/如何贡献.MD
new file mode 100644
index 00000000..4016da89
--- /dev/null
+++ b/docs/如何贡献.MD
@@ -0,0 +1,32 @@
+# 🎋代码分支说明
+- dev：常规开发分支，日常的开发、Bug修复、提交PR都在此分支
+- feature/xxx：特征分支，一些试验性开发、提交PR都在此分支，xxx可自行取一个有意义的名称
+- release/xxx：发行版分支，作为阶段性成果、重大更新的版本固化分支。受保护，不允许任何提交。
+- master：主分支，定期同步最新代码，目前仅支持本人(傲世孤尘/雨韵诗泽)提交。
+
+# ✊贡献的方式
+包括，但不限于以下形式：
+- 提交[issues](https://gitee.com/dromara/neutrino-proxy/issues)
+- 参与[issues](https://gitee.com/dromara/neutrino-proxy/issues)解决的必要性、解决方案的讨论、给出建设性的意见
+- 领取[issues](https://gitee.com/dromara/neutrino-proxy/issues) 并完成开发、提交PR
+- 为[本项目](https://gitee.com/dromara/neutrino-proxy)完善代码注释
+- 为[本项目](https://gitee.com/dromara/neutrino-proxy)增加测试代码
+- 为[本项目](https://gitee.com/dromara/neutrino-proxy)优化现有代码
+- 为[本项目](https://gitee.com/dromara/neutrino-proxy)优化操作体验
+- 通过公众号、博客、贴吧、论坛等形式分享/宣传中微子代理
+- 丰富项目文档，包括使用过程中踩过的坑、需要优化的点、具体问题的解决方法等
+
+# 🧬贡献代码的步骤
+- 在Gitee上fork项目到自己的仓库
+- 将fork后的自己仓库的项目clone到本地
+- 拉取dev分支最新代码，并修改
+- commit并push到自己的仓库
+- 登录Gitee在的仓库上可以看到一个 pull request 按钮，点击它，填写一些说明信息，然后提交即可。
+- 等待合并
+
+# 📐PR的规范
+> 你可能发现有的代码并不符合这个规范，但我们后续都会朝着这个方向迈进。后续我们会逐步全面规范化，请先保证新提交的代码满足以下要求：
+
+- 注释完备，尤其每个新增的方法应按照Java文档规范标明方法说明、参数说明、返回值说明等信息，必要时请添加单元测试，如果愿意，也可以加上你的大名。
+- 原则上，不允许自行添加第三方依赖库。若确有必要，请先和项目负责人沟通达成一致。
+- 对现有代码的优化，请在注释中说明原因。