docs: Add Contributing Guidelines (#463)

This commit is contained in:
渡邉祐一 / Yuichi Watanabe
2023-08-09 13:07:14 +09:00
committed by GitHub
parent 34569895f6
commit a14bc103f4
2 changed files with 97 additions and 15 deletions

View File

@@ -10,12 +10,16 @@ This library provides unofficial Go clients for [OpenAI API](https://platform.op
* DALL·E 2
* Whisper
### Installation:
## Installation
```
go get github.com/sashabaranov/go-openai
```
Currently, go-openai requires Go version 1.18 or greater.
## Usage
### ChatGPT example usage:
```go
@@ -680,20 +684,6 @@ func main() {
</details>
See the `examples/` folder for more.
### Integration tests:
Integration tests are requested against the production version of the OpenAI API. These tests will verify that the library is properly coded against the actual behavior of the API, and will fail upon any incompatible change in the API.
**Notes:**
These tests send real network traffic to the OpenAI API and may reach rate limits. Temporary network problems may also cause the test to fail.
**Run tests using:**
```
OPENAI_TOKEN=XXX go test -v -tags=integration ./api_integration_test.go
```
If the `OPENAI_TOKEN` environment variable is not available, integration tests will be skipped.
## Frequently Asked Questions
### Why don't we get the same answer when specifying a temperature field of 0 and asking the same question?
@@ -725,6 +715,10 @@ For counting tokens, you might find the following links helpful:
**Related Issues:**
[Is it possible to join the implementation of GPT3 Tokenizer](https://github.com/sashabaranov/go-openai/issues/62)
## Contributing
By following [Contributing Guidelines](https://github.com/sashabaranov/go-openai/blob/master/CONTRIBUTING.md), we hope to ensure that your contributions are made smoothly and efficiently.
## Thank you
We want to take a moment to express our deepest gratitude to the [contributors](https://github.com/sashabaranov/go-openai/graphs/contributors) and sponsors of this project: