Skip to content

Apply AsciiDoc style for CONTRIBUTING.adoc #3883

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 23, 2025
Merged

Apply AsciiDoc style for CONTRIBUTING.adoc #3883

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions CONTRIBUTING.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down