From 2b023731bf617d21ad17354de20629e9b25b7320 Mon Sep 17 00:00:00 2001 From: Stefan Bratanov Date: Wed, 24 Jan 2024 09:56:31 +0200 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..93c43d2 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. \ No newline at end of file