This is an automated email from the ASF dual-hosted git repository. orpiske pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git
commit 5efddd2cf65ce18b67f9cbe63d70be9817c298d3 Author: Otavio Rodolfo Piske <[email protected]> AuthorDate: Mon Apr 25 16:29:03 2022 +0200 CAMEL-17894: updated documentation to include notes about auto-formatting --- CONTRIBUTING.md | 4 +++- docs/user-manual/modules/ROOT/pages/building.adoc | 4 ++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f97a70f06e..a9195123642 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,9 @@ Then follow these simple guidelines for working on the code and committing your - Build the project using Maven: - mvn clean install -Pfastinstall + mvn clean install -Pfastinstall,format + +Note: the `format` profile will ensure that the code is properly formatted according to the project standards: - Add a unit test with assertions for your changes. diff --git a/docs/user-manual/modules/ROOT/pages/building.adoc b/docs/user-manual/modules/ROOT/pages/building.adoc index bc348043676..efb5733002d 100644 --- a/docs/user-manual/modules/ROOT/pages/building.adoc +++ b/docs/user-manual/modules/ROOT/pages/building.adoc @@ -55,11 +55,11 @@ the unit tests, which can complete in less than 10 minutes. mvn clean install -Pfastinstall ------------------------------- -== A normal build without running tests but checkstyle verification enabled +== A normal build without running tests but auto formatting and checkstyle verification enabled [source,bash] ------------------------------------------- -mvn clean install -Pfastinstall,sourcecheck +mvn clean install -Pfastinstall,format,sourcecheck ------------------------------------------- == Building with checkstyle
