docs(CONTRIBUTING): clarify Java/JDK toolchain; capitalize terms; tidy code block #575
+3
−4
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Update CONTRIBUTING.md to improve clarity and consistency. Docs-only; no code or CI changes.
Changes (line refs based on commit 9da5ff0)
L5: Reword environment sentence
"The SDK requires Java 8, but development requires JDK 21 for the Kotlin toolchain."
-> "The SDK requires Java 8 for runtime, but development requires JDK 21 for the Kotlin toolchain."
Permalink: https://github.com/deshkaustubh/openai-java/blob/169195c547693bff17fb97b243bb4bbd81650f66/CONTRIBUTING.md#L5
L187: Capitalize “GitHub Action”
"### GitHub action]"
-> "### GitHub Action]"
Permalink: https://github.com/deshkaustubh/openai-java/blob/169195c547693bff17fb97b243bb4bbd81650f66/CONTRIBUTING.md#L187
L206: Capitalize “Gradle” in section heading
"### Available gradle tasks"
-> "### Available Gradle tasks"
Permalink: https://github.com/deshkaustubh/openai-java/blob/169195c547693bff17fb97b243bb4bbd81650f66/CONTRIBUTING.md#L206
L106: Remove stray blank line inside the code block under “Then run the tests”
Before:
After:
Permalink: https://github.com/deshkaustubh/openai-java/blob/169195c547693bff17fb97b243bb4bbd81650f66/CONTRIBUTING.md#L106
Rationale
Scope/Impact
Checklist