Add a remark about how code style rules can be applied automatically.

This commit is contained in:
JanHendrikDolling 2020-03-29 20:17:10 +02:00 committed by Gunnar Morling
parent 20ba237ef2
commit 75865503df

View File

@ -167,6 +167,8 @@ This project utilizes a set of code style rules that are automatically applied b
2. If your IDE does not support importing the Eclipse-based formatter file or you'd rather tidy up the formatting after making your changes locally, you can run a project build to make sure that all code changes adhere to the project's desired style. Instructions on how to run a build locally are provided below. 2. If your IDE does not support importing the Eclipse-based formatter file or you'd rather tidy up the formatting after making your changes locally, you can run a project build to make sure that all code changes adhere to the project's desired style. Instructions on how to run a build locally are provided below.
3. With the command `mvn process-sources` the code style rules can be applied automatically.
In the event that a pull request is submitted with code style violations, continuous integration will fail the pull request build. In the event that a pull request is submitted with code style violations, continuous integration will fail the pull request build.
To fix pull requests with code style violations, simply run the project's build locally and allow the automatic formatting happen. Once the build completes, you will have some local repository files modified to fix the coding style which can be amended on your pull request. Once the pull request is synchronized with the formatting changes, CI will rerun the build. To fix pull requests with code style violations, simply run the project's build locally and allow the automatic formatting happen. Once the build completes, you will have some local repository files modified to fix the coding style which can be amended on your pull request. Once the pull request is synchronized with the formatting changes, CI will rerun the build.