diff --git a/README.md b/README.md index ece6f772..57c8241a 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,8 @@ - [小智安卓端](https://github.com/TOM88812/xiaozhi-android-client) - [小智电脑端](https://github.com/Huang-junsen/py-xiaozhi) +如果你是一名软件开发者,这里有一份[《致开发者的公开信》](docs/contributor_open_letter.md),欢迎加入! + --- ## 警告 ⚠️ diff --git a/docs/contributor_open_letter.md b/docs/contributor_open_letter.md new file mode 100644 index 00000000..1be3da28 --- /dev/null +++ b/docs/contributor_open_letter.md @@ -0,0 +1,51 @@ +# 致开发者的公开信 + +"春江水暖鸭先知,正是河豚欲上时!" + +亲爱的朋友,今天,我怀着无比真挚的心情,向热爱AI技术与创新的你发出这封公开信。 + +我们的开源项目 **xiaozhi-esp32-server** 正处在发展的阶段,它承载着我们对智能硬件和低成本民用贾维斯解决方案的美好憧憬,也希望借助每一位开发者的智慧,共同开创技术的新局面。 + +## 项目目标 + +1. **民用低成本贾维斯解决方案** + +2. **智能联动周边硬件的解决方案** + +## 加入我们 + +我们热忱欢迎志同道合的朋友加入,共同为项目贡献力量。参与方式如下: + +### 1、成为普通贡献者 + +Fork 项目,提交 PR,由开发者审核后合入主分支。 + +### 2、成为开发者 + +当你累计提交 3 次有效 PR 后,可以联系群主申请成为开发者,群主将邀请你加入独立的开发者群,共同探讨项目未来。 + +## 开发者开发流程 + +1. **创建新分支** + 每个功能点请以新分支方式开发,分支名称应简洁明了,让人一眼看出所实现的功能,避免功能撞车。 + +2. **提交 PR 审核** + 功能开发完成后,请在 GitHub 上提交 PR,由其他开发者审核,审核通过后合并入主分支。 + +## 功能点的来源 + +- **创新的点子与功能** + 你的每一个灵感都可能成为项目的突破点,欢迎大胆提出前沿的创意与功能建议。 + +- **代码优化** + 如果你发现代码中存在改进的空间,欢迎提交优化方案,让我们的代码更加高效、易读。 + +- **解决 Issues 问题** + Issues 中有很多问题需要解决,我们一同完善、打造产品。 + +亲爱的开发者们, +每一次提交、每一份建议,都是对我们共同梦想的加持。每一代人有每一代人的使命,让我们共同书写智能生活的新篇章! + +期待与你携手前行,共创未来。 + +John,2025.3.11,广州 \ No newline at end of file diff --git a/main/README.md b/main/README.md index 2e164954..6f330023 100644 --- a/main/README.md +++ b/main/README.md @@ -3,7 +3,7 @@ # 项目目录介绍 当你看到这份文件的时候,这个这个项目还没完善好。我们还有很多东西要做。 -如果你会开发,我们非常欢迎您的加入。 +如果你是一名软件开发者,这里有一份[《致开发者的公开信》](../docs/contributor_open_letter.md),欢迎归队! ``` xiaozhi-esp32-server