update contribution docs

This commit is contained in:
Mark Pollack
2024-06-20 10:38:30 -04:00
parent 400d0d156c
commit 6bd3bca1d7

View File

@@ -1,6 +1,16 @@
[[contribution-guidelines]]
= Contribution Guidelines
== Code Formatting and Javadoc
Before submitting a PR, please run the following commands to ensure proper formatting and Javadoc processing
```
./mvnw spring-javaformat:apply javadoc:javadoc -Pjavadoc
```
The `-Pjavadoc` is a profile that enables Javadoc processing so as to avoid a long build time when developing.
== Contributing a New AI Model Implementation
This section outlines the steps for contributing a new AI model implementation.