Contributions are highly welcome. Feel free to submit Pull Requests. Maybe watch out for tickets tagged with ideal-for-contribution, these tickets should always be a good starting point for contributing.
You can find some hints for starting development in the README of spring-boot-admin-server-ui.
We try to satisfy the Code Style of Spring Framework.
The Spring Java Format Plugin is added to the build. Checkstyle will enforce the consistency of the code. Nevertheless there are some disabled rules, due to backward compatibility. You can find these disabled rules in a comment in src/checkstyle/checkstyle.xml.
Otherwise you can always run mvn spring-javaformat:apply to fix some basic errors, like indentation.
tbd
The IntelliJ settings are based on the IntelliJ-IDEA-Editor-Settings from spring, but have been adapted slightly, you can find the original settings here.
The custom settings are stored in .editorconfig and are imported automatically by IntelliJ.
If you are using IntelliJ, there is also a formatter-plugin provided by Spring.
(i) Plugin version x didn't not work in IntelliJ IDEA Ultimate 2020.3.
This plugin scans Java files with the project's custom CheckStyle rules from within IDEA.
Install and configure the Checkstyle Plugin, and enable the configuration file.
Before the configuration file is configured, add the spring-javaformat-checkstyle JAR to the Third-Party Checks.
- Preferences > Tools > Checkstyle > Third-Party Checks
- Add
~/.m2/repository/io/spring/javaformat/spring-javaformat-checkstyle/0.0.26/spring-javaformat-checkstyle-0.0.26.jar
Add the configuration file and enabled it:
- Preferences > Tools > Checkstyle > Configuration File > +
- Add a Name, ex. Spring Boot Admin
- Use a local Checkstyle File, Browse to
src/checkstyle/checkstyle.xmland click Next - Enter the full path to the checkstyle header file:
<git repo>/src/checkstyle/checkstyle-header.txt, click Finish - Select the new configuration file to enable it
TODO