|
|
|
|
@@ -41,7 +41,7 @@ public class Application {
|
|
|
|
|
It's just a Spring Boot application, so it can be built, run and
|
|
|
|
|
tested, locally and in a CI build, the same way as any other Spring
|
|
|
|
|
Boot application. The `Function` is from `java.util` and `Flux` is a
|
|
|
|
|
http://www.reactive-streams.org/[Reactive Streams] `Publisher` from
|
|
|
|
|
https://www.reactive-streams.org/[Reactive Streams] `Publisher` from
|
|
|
|
|
https://projectreactor.io/[Project Reactor]. The function can be
|
|
|
|
|
accessed over HTTP or messaging.
|
|
|
|
|
|
|
|
|
|
@@ -158,7 +158,7 @@ credentials and you already have those.
|
|
|
|
|
|
|
|
|
|
The projects that require middleware generally include a
|
|
|
|
|
`docker-compose.yml`, so consider using
|
|
|
|
|
http://compose.docker.io/[Docker Compose] to run the middeware servers
|
|
|
|
|
https://compose.docker.io/[Docker Compose] to run the middeware servers
|
|
|
|
|
in Docker containers. See the README in the
|
|
|
|
|
https://github.com/spring-cloud-samples/scripts[scripts demo
|
|
|
|
|
repository] for specific instructions about the common cases of mongo,
|
|
|
|
|
@@ -180,13 +180,13 @@ a modified file in the correct place. Just commit it and push the change.
|
|
|
|
|
|
|
|
|
|
=== Working with the code
|
|
|
|
|
If you don't have an IDE preference we would recommend that you use
|
|
|
|
|
http://www.springsource.com/developer/sts[Spring Tools Suite] or
|
|
|
|
|
http://eclipse.org[Eclipse] when working with the code. We use the
|
|
|
|
|
http://eclipse.org/m2e/[m2eclipse] eclipse plugin for maven support. Other IDEs and tools
|
|
|
|
|
https://www.springsource.com/developer/sts[Spring Tools Suite] or
|
|
|
|
|
https://eclipse.org[Eclipse] when working with the code. We use the
|
|
|
|
|
https://eclipse.org/m2e/[m2eclipse] eclipse plugin for maven support. Other IDEs and tools
|
|
|
|
|
should also work without issue as long as they use Maven 3.3.3 or better.
|
|
|
|
|
|
|
|
|
|
==== Importing into eclipse with m2eclipse
|
|
|
|
|
We recommend the http://eclipse.org/m2e/[m2eclipse] eclipse plugin when working with
|
|
|
|
|
We recommend the https://eclipse.org/m2e/[m2eclipse] eclipse plugin when working with
|
|
|
|
|
eclipse. If you don't already have m2eclipse installed it is available from the "eclipse
|
|
|
|
|
marketplace".
|
|
|
|
|
|
|
|
|
|
@@ -244,7 +244,7 @@ added after the original pull request but before a merge.
|
|
|
|
|
`eclipse-code-formatter.xml` file from the
|
|
|
|
|
https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring
|
|
|
|
|
Cloud Build] project. If using IntelliJ, you can use the
|
|
|
|
|
http://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter
|
|
|
|
|
https://plugins.jetbrains.com/plugin/6546[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
|
|
|
|
|
@@ -257,7 +257,7 @@ added after the original pull request but before a merge.
|
|
|
|
|
* 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 http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions],
|
|
|
|
|
* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[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).
|
|
|
|
|
|
|
|
|
|
@@ -328,7 +328,7 @@ If you need to suppress some rules (e.g. line length needs to be longer), then i
|
|
|
|
|
<?xml version="1.0"?>
|
|
|
|
|
<!DOCTYPE suppressions PUBLIC
|
|
|
|
|
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
|
|
|
|
|
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
|
|
|
|
|
"https://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
|
|
|
|
|
<suppressions>
|
|
|
|
|
<suppress files=".*ConfigServerApplication\.java" checks="HideUtilityClassConstructor"/>
|
|
|
|
|
<suppress files=".*ConfigClientWatch\.java" checks="LineLengthCheck"/>
|
|
|
|
|
|