@@ -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
@@ -77,17 +77,17 @@ project to which you’re trying to contribute but that you don’t maintain."_
7777
7878== Keeping your Local Code in Sync
7979* As mentioned above, you should always work on topic branches (since 'main' is a moving target). However, you do want
80- to always keep your own 'origin' main branch in synch with the 'upstream' main.
80+ to always keep your own 'origin' main branch in sync with the 'upstream' main.
8181* Within your local working directory, you can sync up all remotes' branches with: `git fetch --all`
8282* While on your own local main branch: `git pull upstream main` (which is the equivalent of fetching upstream/main
8383and merging that into the branch you are in currently)
84- * Now that you're in synch , switch to the topic branch where you plan to work, e.g.: `git checkout -b GH-123`
84+ * Now that you're in sync , switch to the topic branch where you plan to work, e.g.: `git checkout -b GH-123`
8585* When you get to a stopping point: `git commit`
86- * If changes have occurred on the upstream/main while you were working you can synch again:
86+ * If changes have occurred on the upstream/main while you were working you can sync again:
8787- Switch back to main: `git checkout main`
8888- Then: `git pull upstream main`
8989- Switch back to the topic branch: `git checkout GH-123` (no -b needed since the branch already exists)
90- - Rebase the topic branch to minimize the distance between it and your recently synched main branch: `git rebase main`
90+ - Rebase the topic branch to minimize the distance between it and your recently synced main branch: `git rebase main`
9191(Again, for more detail see https://git-scm.com/book/en/Git-Branching-Rebasing[the Pro Git section on rebasing]).
9292* **Note** You cannot rebase if you have already pushed your branch to your remote because you'd be rewriting history
9393(see **'The Perils of Rebasing'** in the article).
@@ -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