Trying to improve the overall code quality of the project, this activity mostly included minor, non-breaking, code refactoring such as e.g.: pulling duplicated code intro common abstractions, making fields final when possible, making proper usage of SLF4J, reorganizing the test package structure, adhering to the Java & Surefire naming conventions, getting rid of unnecessary code, addressing typical code smells, and more.
Does this introduce a breaking change?
[ ] Yes
[x] No
Pull Request Type
What kind of change does this Pull Request introduce?
[ ] Bugfix
[ ] Feature
[x] Code style update (formatting, local variables)
[x] Refactoring (no functional changes, no api changes)
[x] Documentation content changes
[ ] Other... Please describe:
Other Information
I tried to avoid formatting the whole class but sometimes had to resort to it due to the indentation of most sections being outside of the standard used in other classes (e.g.: <> 4 spaces).
Feel free to use the Hide whitespace Diff view feature while reviewing the PR as it might help with certain classes 🙏
While I was at it, I've also:
added the .iml file format to the .gitignore, as this is an IntelliJ byproduct.
got rid of the assets directory as it was only used to host a single image that was referenced in the README.md file. That image has been moved to the docs folder instead, along with all the other images that are referenced by the README.md file.
Purpose
Trying to improve the overall code quality of the project, this activity mostly included minor, non-breaking, code refactoring such as e.g.: pulling duplicated code intro common abstractions, making fields final when possible, making proper usage of SLF4J, reorganizing the test package structure, adhering to the Java & Surefire naming conventions, getting rid of unnecessary code, addressing typical code smells, and more.
Does this introduce a breaking change?
Pull Request Type
What kind of change does this Pull Request introduce?
Other Information
I tried to avoid formatting the whole class but sometimes had to resort to it due to the indentation of most sections being outside of the standard used in other classes (e.g.:![hide whitespace](https://github.com/Azure-Samples/azure-search-openai-demo-java/assets/24280982/ca6766b8-50e1-4f79-a040-f5a7418c972c)
<> 4 spaces
). Feel free to use theHide whitespace
Diff view feature while reviewing the PR as it might help with certain classes 🙏While I was at it, I've also:
.iml
file format to the.gitignore
, as this is an IntelliJ byproduct.assets
directory as it was only used to host a single image that was referenced in theREADME.md
file. That image has been moved to thedocs
folder instead, along with all the other images that are referenced by theREADME.md
file.