anchor.diff:    other target branch in the main project).
   * 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).+  message (where XXXX is the issue number).
  +
  +=== Checkstyle
  +
  +Spring Cloud Build comes with a set of checkstyle rules. You can find them in the `spring-cloud-build-tools` module. The most notable files under the module are:
  +
  +.spring-cloud-build-tools/
  +----
  +└── src
  +    ├── checkstyle
  +    │   └── checkstyle-suppressions.xml <3>
  +    └── main
  +        └── resources
  +            ├── checkstyle-header.txt <2>
  +            └── checkstyle.xml <1>
  +----
  +<1> Default Checkstyle rules
  +<2> File header setup
  +<3> Default suppression rules
  +
  +==== Checkstyle configuration
  +
  +Checkstyle rules are *disabled by default*. To add checkstyle to your project just define the following properties and plugins.
  +
  +.pom.xml
  +----
  +<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>
  +----
  +<1> Fails the build upon Checkstyle errors
  +<2> Fails the build upon Checkstyle violations
  +<3> Checkstyle analyzes also the test sources
  +<4> Add the Spring Java Format plugin that will reformat your code to pass most of the Checkstyle formatting rules
  +<5> 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:
  +
  +.projectRoot/src/checkstyle/checkstyle-suppresions.xml
  +----
  +<?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 `${spring-cloud-build.rootFolder}/.editorconfig` and `${spring-cloud-build.rootFolder}/.springformat` to your project. That way, some default formatting rules will be applied. You can do so by running this script:
  +
  +```bash
  +$ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/.editorconfig -o .editorconfig
  +$ touch .springformat
  +```
  +
  +=== IDE setup
  +
  +==== Intellij IDEA
  +
  +In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin.
  +
  +.spring-cloud-build-tools/
  +----
  +└── 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>
  +----
  +<1> Default Checkstyle rules
  +<2> File header setup
  +<3> Default suppression rules
  +<4> Project defaults for Intellij that apply most of Checkstyle rules
  +<5> Project style conventions for Intellij that apply most of Checkstyle rules
  +
  +.Code style
  +
  +image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-code-style.png[Code style]
  +
  +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 `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Spring_Boot_Java_Conventions.xml` file.
  +
  +.Inspection profiles
  +
  +image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-inspections.png[Code style]
  +
  +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 `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Project_Defaults.xml` file.
  +
  +.Checkstyle
  +
  +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
  +
  +image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-checkstyle.png[Checkstyle]
  +
  +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 Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables:
  +
  +- `checkstyle.header.file` - please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/main/resources/checkstyle/checkstyle-header.txt` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` URL.
  +- `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-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.
positive.code: 
  The projects that require middleware generally include a
  `docker-compose.yml`, so consider using
  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,
  
negative.code: ////
  DO NOT EDIT THIS FILE. IT WAS GENERATED.
  Manual changes to this file will be lost when it is generated again.
  Edit the files in the src/main/asciidoc/ directory instead.
  ////
  
  image::https://badges.gitter.im/Join%20Chat.svg["Gitter",link="https://gitter.im/spring-cloud/spring-cloud-security?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
  
  