Spring AI 提交 PR 实战指南：避免常见坑

zxc

今天，我们将简单地了解如何向 Spring AI 提交 PR（Pull Request）。在这个过程中，有一些常见的坑需要大家注意和避免，特别是在 Git 操作方面。我们会重点关注提交信息的规范，如何进行一次合并提交，以及其他在代码质量和结构上需要遵守的要求。
最后，我们会快速回顾一下与代码相关的一些主要规范和注意事项。好的，接下来我们就来详细看看这些内容。
代码

如果你在代码层面上只是简单地提交了一部分代码，通常情况下并不需要编写详细的测试报告，然而，如果你提交的是一个完整的需求实现，那么你的代码类就必须包含相应的单元测试。

类信息

请确保在编写代码时，记得注明自己的作者信息，并在适当的位置添加注释。注释可以包括但不限于以下内容：类的属性说明、每个方法的功能描述、参数和返回值的解释等。

敏感信息

请务必注意，在提交时，确保自己的类文件中不包含任何敏感的秘钥信息。若类文件中含有秘钥信息，提交将会失败，因此建议在提交前仔细检查文件内容。如果不小心已经提交了包含秘钥信息的文件，您需要进行相应的Git操作来彻底删除那次提交历史。否则，问题将依旧存在，后续的提交仍然会因为包含秘钥信息而失败。
Git

Git提交时，切记需要包含sign信息，如下所示：

feat(spring-ai): add HunYuan AI
Signed-off-by: StudiousXiaoYu 1316356098@qq.com

由于Spring AI 会自动监测Pull Request (PR) 中的提交信息，因此如果你未按要求提前准备相关信息，可能会导致需要进行一系列繁琐的操作，浪费大量时间和精力。为了避免这种不必要的麻烦，建议你在提交之前提前将所有相关信息准备好，这样可以确保流程的顺利进行，节省后续处理的时间。如图所示：

压缩提交

如果你喜欢在修改了一部分代码后，将其随机提交到本地仓库进行保存，但Spring AI的要求是必须压缩提交记录，那么你可以采用以下方法来实现这一要求。就像前面提到的，如果你提交了包含秘钥信息的代码，你也可以通过类似的方式来处理这个问题。具体操作如下：

然后右键，如图所示：

在弹窗中，记得选择soft方式进行重置，最后我们所有的提交，就会全都变成未推送状态，这时候你重新全都推送一次即可成功！
总之，向 Spring AI 提交 PR 的过程虽然看似简单，但需要注意细节，避免常见的 Git 操作失误。规范的提交信息、合并提交的处理、敏感信息的管理以及代码质量的维护，都是确保顺利提交的关键。通过提前准备好所有相关信息，避免冗长的修正过程，可以有效提升工作效率。
<hr>我是努力的小雨，一个正经的 Java 东北服务端开发，整天琢磨着 AI 技术这块儿的奥秘。特爱跟人交流技术，喜欢把自己的心得和大家分享。还当上了腾讯云创作之星，阿里云专家博主，华为云云享专家，掘金优秀作者。各种征文、开源比赛的牌子也拿了。
💡 想把我在技术路上走过的弯路和经验全都分享出来，给你们的学习和成长带来点启发，帮一把。
🌟 欢迎关注努力的小雨，咱一块儿进步！🌟