@@ -7,7 +7,7 @@ what kind of changes are likely to be accepted; and what to expect from the Spri
77Please refer back to this document as a checklist before issuing any pull request; this will save time for everyone!
88
99== Code of Conduct  
10- This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc [code of conduct].
10+ This project adheres to the Contributor Covenant https://github.com/spring-projects/spring-ai#coc-ov-file [code of conduct].
1111By participating, you  are expected to uphold this code. Please report unacceptable behavior to
12121313
@@ -133,6 +133,25 @@ This command, will provide the following output, which in this case shows a nice
133133If you see intersecting lines, that usually means that you forgot to rebase you branch.
134134As mentioned earlier, **please rebase against main** before issuing a pull request.
135135
136+ == Enabling Checkstyle
137+ 
138+ Checkstyles are currently disabled in the project.
139+ However, we encourage all PR contributors to run checkstyles by enabling them before submitting a PR.
140+ 
141+ You can enable them by doing the following:
142+ 
143+ ```shell
144+ ./mvnw clean package -DskipTests -Ddisable.checks=false
145+ ```
146+ 
147+ === Source Code Style
148+ 
149+ Spring AI source code checkstyle tries to follow the checkstyle guidelines used by the core Spring Framework project with some exceptions.
150+ The wiki pages
151+ [Code Style](https://github.com/spring-projects/spring-framework/wiki/Code-Style) and
152+ [IntelliJ IDEA Editor Settings](https://github.com/spring-projects/spring-framework/wiki/IntelliJ-IDEA-Editor-Settings)
153+ define the source file coding standards we use along with some IDEA editor settings we customize.
154+ 
136155== Mind the whitespace
137156
138157Please carefully follow the whitespace and formatting conventions already present in the framework.
@@ -265,4 +284,4 @@ Also by using specific
265284https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword[keywords]
266285you can link to a GitHub issue like so:
267286
268-     Closes #10
287+     Closes #10
0 commit comments