代码拉取完成，页面将自动刷新
None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.
Use the Guerlab.net code format conventions.
If you use Eclipse you can import formatter settings using the eclipse-code-formatter.xml file from the eclipse path.
If using IntelliJ, you can use the Eclipse Code Formatter Plugin to import the same file.
Make sure all new .java files to have a simple Javadoc class comment with at least an
@author tag identifying you, and preferably at least a paragraph on what the class is for.
Add the ASF license header comment to all new .java files (copy from existing files in the project)
Add yourself as an @author to the .java files that you modify substantially (more than cosmetic changes).
Add some Javadocs and, if you change the namespace, some XSD doc elements.
A few unit tests would help a lot as well — someone has to do it.
If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
When writing a commit message please follow these conventions, if you are fixing an existing issue please add Fixes gh-XXXX at the end of the commit message (where XXXX is the issue number).
Guerlab.net comes with a set of checkstyle rules.
You can find them in the guerlab-builder-tools module.
The most notable files under the module are:
└── src
├── checkstyle
│ └── checkstyle-suppressions.xml (3)
└── main
└── resources
├── checkstyle-header.txt (2)
└── checkstyle.xml (1)
Default Checkstyle rules
File header setup
Default suppression rules
Checkstyle rules are disabled by default. To add checkstyle to your project just define the following properties and plugins.
<properties>
<maven-checkstyle-plugin.failsOnError>true</maven-checkstyle-plugin.failsOnError> (1)
<maven-checkstyle-plugin.failsOnViolation>true</maven-checkstyle-plugin.failsOnViolation> (2)
<maven-checkstyle-plugin.includeTestSourceDirectory>true</maven-checkstyle-plugin.includeTestSourceDirectory> (3)
</properties>
<build>
<plugins>
<plugin> (4)
<groupId>io.spring.javaformat</groupId>
<artifactId>spring-javaformat-maven-plugin</artifactId>
</plugin>
<plugin> (5)
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
</plugin>
</plugins>
<reporting>
<plugins>
<plugin> (5)
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
</plugin>
</plugins>
</reporting>
</build>
Fails the build upon Checkstyle errors
Fails the build upon Checkstyle violations
Checkstyle analyzes also the test sources
Add the Spring Java Format plugin that will reformat your code to pass most of the Checkstyle formatting rules
Add checkstyle plugin to your build and reporting phases
If you need to suppress some rules (e.g. line length needs to be longer), then it’s enough for you to define a file under ${project.root}/src/checkstyle/checkstyle-suppressions.xml with your suppressions.
Example:
<?xml version="1.0"?> <!DOCTYPE suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.1//EN" "https://www.puppycrawl.com/dtds/suppressions_1_1.dtd"> <suppressions> <suppress files=".*ConfigServerApplication\.java" checks="HideUtilityClassConstructor"/> <suppress files=".*ConfigClientWatch\.java" checks="LineLengthCheck"/> </suppressions>
It’s advisable to copy the ${guerlab-builder.rootFolder}/.editorconfig and ${guerlab-builder.rootFolder}/.springformat to your project.
That way, some default formatting rules will be applied.
You can do so by running this script:
$ curl https://gitee.com/guerlab_net/guerlab-builder/raw/master/.editorconfig -o .editorconfig
$ touch .springformat
In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin. The following files can be found in the Guerlab Build project.
└── src
├── checkstyle
│ └── checkstyle-suppressions.xml (3)
└── main
└── resources
├── checkstyle-header.txt (2)
├── checkstyle.xml (1)
└── intellij
├── Intellij_Project_Defaults.xml (4)
└── Intellij_Spring_Boot_Java_Conventions.xml (5)
Default Checkstyle rules
File header setup
Default suppression rules
Project defaults for Intellij that apply most of Checkstyle rules
Project style conventions for Intellij that apply most of Checkstyle rules
Go to File → Settings → Editor → Code style.
There click on the icon next to the Scheme section.
There, click on the Import Scheme value and pick the Intellij IDEA code style XML option.
Import the guerlab-builder-tools/src/main/resources/intellij/Intellij_Guerlab_Net_Java_Conventions.xml file.
Go to File → Settings → Editor → Inspections.
There click on the icon next to the Profile section.
There, click on the Import Profile and import the guerlab-builder-tools/src/main/resources/intellij/Intellij_Guerlab_Net.xml file.
To have Intellij work with Checkstyle, you have to install the Checkstyle plugin.
It’s advisable to also install the Assertions2Assertj to automatically convert the JUnit assertions
Go to File → Settings → Other settings → Checkstyle.
There click on the + icon in the Configuration file section.
There, you’ll have to define where the checkstyle rules should be picked from.
In the image above, we’ve picked the rules from the cloned Guerlab Builder repository.
However, you can point to the Guerlab Builder’s GitHub repository (e.g. for the checkstyle.xml : https://gitee.com/guerlab_net/guerlab-builder/raw/master/guerlab-builder-tools/src/main/resources/checkstyle.xml).
We need to provide the following variables:
checkstyle.header.file - please point it to the Guerlab Builder’s, guerlab-builder-tools/src/main/resources/checkstyle-header.txt file either in your cloned repo or via the https://gitee.com/guerlab_net/guerlab-builder/raw/master/guerlab-builder-tools/src/main/resources/checkstyle-header.txt URL.
checkstyle.suppressions.file - default suppressions.
Please point it to the Guerlab Builder’s, guerlab-builder-tools/src/checkstyle/checkstyle-suppressions.xml file either in your cloned repo or via the https://gitee.com/guerlab_net/guerlab-builder/raw/master/guerlab-builder-tools/src/checkstyle/checkstyle-suppressions.xml URL.
checkstyle.additional.suppressions.file - this variable corresponds to suppressions in your local project.
E.g. you’re working on spring-cloud-contract.
Then point to the project-root/src/checkstyle/checkstyle-suppressions.xml folder.
Example for spring-cloud-contract would be: /home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml.
|
Important
|
Remember to set the Scan Scope to All sources since we apply checkstyle rules for production and test sources.
|
Guerlab Builder brings along the basepom:duplicate-finder-maven-plugin, that enables flagging duplicate and conflicting classes and resources on the java classpath.
Duplicate finder is enabled by default and will run in the verify phase of your Maven build, but it will only take effect in your project if you add the duplicate-finder-maven-plugin to the build section of the projecst’s pom.xml.
<build>
<plugins>
<plugin>
<groupId>org.basepom.maven</groupId>
<artifactId>duplicate-finder-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
For other properties, we have set defaults as listed in the plugin documentation.
You can easily override them but setting the value of the selected property prefixed with duplicate-finder-maven-plugin.
For example, set duplicate-finder-maven-plugin.skip to true in order to skip duplicates check in your build.
If you need to add ignoredClassPatterns or ignoredResourcePatterns to your setup, make sure to add them in the plugin configuration section of your project:
<build>
<plugins>
<plugin>
<groupId>org.basepom.maven</groupId>
<artifactId>duplicate-finder-maven-plugin</artifactId>
<configuration>
<ignoredClassPatterns>
<ignoredClassPattern>org.joda.time.base.BaseDateTime</ignoredClassPattern>
<ignoredClassPattern>.*module-info</ignoredClassPattern>
</ignoredClassPatterns>
<ignoredResourcePatterns>
<ignoredResourcePattern>changelog.txt</ignoredResourcePattern>
</ignoredResourcePatterns>
</configuration>
</plugin>
</plugins>
</build>
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。