github/openai.openai-go
2
0
Fork 0
mirror of https://github.com/openai/openai-go.git synced 2026-04-01 17:17:14 +09:00
Code Issues Packages Projects Releases Wiki Activity

docs: update CONTRIBUTING.md (#51)

Browse Source
This commit is contained in:
stainless-app[bot]
2024-09-13 15:30:28 +00:00
committed by GitHub
parent 48accd4f97
commit 2ecc69b487
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@@ -6,13 +6,13 @@ Install go by following relevant directions [here](https://go.dev/doc/install).
## Modifying/Adding code
Most of the SDK is generated code, and any modified code will be overridden on the next generation. The
`examples/` directory is an exception and will never be overridden.
Most of the SDK is generated code. Modifications to code will be persisted between generations, but may
result in merge conflicts between manual patches and changes from the generator. The generator will never
modify the contents of the `lib/` and `examples/` directories.
## Adding and running examples
All files in the `examples/` directory are not modified by the Stainless generator and can be freely edited or
added to.
All files in the `examples/` directory are not modified by the generator and can be freely edited or added to.
```bash
# add an example to examples/<your-example>/main.go