Spring Cloud Kubernetes编码约定和客房整理
2024-01-08 17:38 更新
其中的None对于请求请求至关重要,但它们都会有所帮助。也可以在原始请求请求之后但在合并之前添加它们。
- 使用Spring Framework代码格式约定。如果您使用Eclipse,则可以使用
Spring Cloud Build
项目中的
eclipse-code-formatter.xml
文件导入格式化程序设置 。如果使用IntelliJ,则可以使用 Eclipse Code Formatter插件来导入相同的文件。 - 确保所有新的
.java
文件都具有简单的Javadoc类注释,并至少带有一个@author
标签来标识您,并且最好至少包含有关该类用途的段落。 - 将ASF许可证标头注释添加到所有新的
.java
文件(从项目中的现有文件复制) - 将您自己作为
@author
添加到您进行了实质性修改(不仅仅是外观更改)的.java文件中。 - 添加一些Javadocs,如果更改名称空间,则添加一些XSD doc元素。
- 进行一些单元测试也有很大帮助-有人必须这样做。
- 如果没有其他人在使用您的分支,请根据当前的主节点(或主项目中的其他目标分支)对其进行重新设置。
- 编写提交消息时,请遵循以下约定,如果要解决现有问题,请在提交消息的末尾添加
Fixes gh-XXXX
(其中XXXX是问题编号)。
以上内容是否对您有帮助:
更多建议: