今天,我们将简单地了解如何向 Spring AI 提交 PR(Pull Request)。在这个过程中,有一些常见的坑需要大家注意和避免,特别是在 Git 操作方面。我们会重点关注提交信息的规范,如何进行一次合并提交,以及其他在代码质量和结构上需要遵守的要求。
最后,我们会快速回顾一下与代码相关的一些主要规范和注意事项。好的,接下来我们就来详细看看这些内容。
代码
如果你在代码层面上只是简单地提交了一部分代码,通常情况下并不需要编写详细的测试报告,然而,如果你提交的是一个完整的需求实现,那么你的代码类就必须包含相应的单元测试。
类信息
请确保在编写代码时,记得注明自己的作者信息,并在适当的位置添加注释。注释可以包括但不限于以下内容:类的属性说明、每个方法的功能描述、参数和返回值的解释等。
敏感信息
请务必注意,在提交时,确保自己的类文件中不包含任何敏感的秘钥信息。若类文件中含有秘钥信息,提交将会失败,因此建议在提交前仔细检查文件内容。如果不小心已经提交了包含秘钥信息的文件,您需要进行相应的Git操作来彻底删除那次提交历史。否则,问题将依旧存在,后续的提交仍然会因为包含秘钥信息而失败。