Skip to content

Commit 6bd3bca

Browse files
committed
update contribution docs
1 parent 400d0d1 commit 6bd3bca

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

spring-ai-docs/src/main/antora/modules/ROOT/pages/contribution-guidelines.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
[[contribution-guidelines]]
22
= Contribution Guidelines
33

4+
== Code Formatting and Javadoc
5+
6+
Before submitting a PR, please run the following commands to ensure proper formatting and Javadoc processing
7+
8+
```
9+
./mvnw spring-javaformat:apply javadoc:javadoc -Pjavadoc
10+
```
11+
12+
The `-Pjavadoc` is a profile that enables Javadoc processing so as to avoid a long build time when developing.
13+
414
== Contributing a New AI Model Implementation
515

616
This section outlines the steps for contributing a new AI model implementation.

0 commit comments

Comments
 (0)