-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
80961ff
commit 2b02373
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Contributing | ||
|
||
Thank you for your interest in contributing to this project! 🎉👍 | ||
|
||
The following is a set of guidelines for contributing to this repo: | ||
|
||
* Use JDK 17 or newer to build the project. | ||
* Google's Java coding conventions are used for the project. To reformat code, run: | ||
|
||
```bash | ||
./gradlew spotlessApply | ||
``` | ||
|
||
* Running some of the tests in classes extending `OpenAIIntegrationTestBase` require to | ||
set `OPENAI_API_KEY` environment variable with your | ||
API key. Refer to | ||
these [instructions](https://platform.openai.com/docs/api-reference/authentication) to create one. No need to run | ||
those tests if you don't have an API key or don't want to spend your balance. Can rely on CI executing those instead. | ||
😉 | ||
* If your PR modifies a request/response object, please add the changes in `TestDataUtil` and | ||
run the `OpenApiSpecificationValidationTest` tests to ensure | ||
the [spec](https://github.com/openai/openai-openapi/raw/master/openapi.yaml) is not violated. | ||
* If your PR adds a new endpoint, please refer to the classes extending `OpenAIClient` for code examples. |