From fbb5a0dd595690010cfb12f05541e47abd87bdd6 Mon Sep 17 00:00:00 2001 From: Tran Ngoc Nhan Date: Tue, 22 Jul 2025 19:38:35 +0700 Subject: [PATCH] Apply AsciiDoc style Signed-off-by: Tran Ngoc Nhan --- CONTRIBUTING.adoc | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index c763884e40b..13562a36323 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -32,7 +32,7 @@ For additional details, please refer to the blog post https://spring.io/blog/202 1. Go to https://github.com/spring-projects/spring-ai[https://github.com/spring-projects/spring-ai] 2. Hit the "fork" button and choose your own GitHub account as the target -3. For more detail see https://help.github.com/fork-a-repo/[Fork A Repo]. +3. For more detail see https://help.github.com/articles/fork-a-repo/[Fork A Repo]. == Setup your Local Development Environment @@ -140,16 +140,17 @@ However, we encourage all PR contributors to run checkstyles by enabling them be You can enable them by doing the following: -```shell +[source,shell] +---- ./mvnw clean package -DskipTests -Ddisable.checks=false -``` +---- === Source Code Style Spring AI source code checkstyle tries to follow the checkstyle guidelines used by the core Spring Framework project with some exceptions. The wiki pages -[Code Style](https://github.com/spring-projects/spring-framework/wiki/Code-Style) and -[IntelliJ IDEA Editor Settings](https://github.com/spring-projects/spring-framework/wiki/IntelliJ-IDEA-Editor-Settings) +https://github.com/spring-projects/spring-framework/wiki/Code-Style[Code Style] and +https://github.com/spring-projects/spring-framework/wiki/IntelliJ-IDEA-Editor-Settings[IntelliJ IDEA Editor Settings] define the source file coding standards we use along with some IDEA editor settings we customize. == Mind the whitespace