Skip to content

Latest commit

 

History

History
18 lines (11 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

18 lines (11 loc) · 1.26 KB

Contributing to Spring Boot Admin

Contriubutions 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.

Coding Conventions

Java / Server

We try to satisfy the Code Style of Spring Framework. If you are using IntelliJ, you can find the needed settings here.

The Spring Java Format Plugins are 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.xml.

If you are using IntelliJ, there is also a formatter-plugin provided by Spring.

Otherwise you can always run mvn spring-javaformat:apply to fix some basic errors, like indentation.

JavaScript / Client

tbd