Skip to content

docs(CONTRIBUTING): clarify Java/JDK toolchain; capitalize terms; tidy code block #575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
+3 −4
Closed

docs(CONTRIBUTING): clarify Java/JDK toolchain; capitalize terms; tidy code block #575

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Setting up the environment

This repository uses [Gradle](https://gradle.org/) with Kotlin DSL for building and dependency management. The SDK requires Java 8, but development requires JDK 21 for the Kotlin toolchain.
This repository uses [Gradle](https://gradle.org/) with Kotlin DSL for building and dependency management. The SDK requires Java 8 for runtime, but development requires JDK 21 for the Kotlin toolchain.

## Project structure

Expand Down Expand Up @@ -103,7 +103,6 @@ Then run the tests:

```sh
$ ./scripts/test

```

### Test configuration
Expand Down Expand Up @@ -184,7 +183,7 @@ the changes aren't made through the automated pipeline, you may want to make rel

### Publish with a GitHub workflow

You can release to package managers by using [the `Publish Sonatype` GitHub action](https://www.github.com/openai/openai-java/actions/workflows/publish-sonatype.yml). This requires setup organization or repository secrets to be configured.
You can release to package managers by using [the `Publish Sonatype` GitHub Action](https://www.github.com/openai/openai-java/actions/workflows/publish-sonatype.yml). This requires setup organization or repository secrets to be configured.

### Publish manually

Expand All @@ -203,7 +202,7 @@ This requires the following environment variables to be set:

## Development tools

### Available gradle tasks
### Available Gradle tasks

Some useful Gradle tasks:

Expand Down