Skip to content

Commit

Permalink
Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
StefanBratanov committed Jan 24, 2024
1 parent 80961ff commit 2b02373
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
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.

0 comments on commit 2b02373

Please sign in to comment.