Skip to content

Commit c9f222f

Browse files
docs: clarify collaborator-only pull request policy (#1066)
## Summary Make the contribution guidance match the repository's collaborator-only pull request policy. The README links to CONTRIBUTING.md, both explicitly exclude PRs from non-collaborators, and community feedback goes through issues. Existing development instructions remain available to collaborators, and security reports continue through the private disclosure process. Retarget the existing security-model references shifted by the new contribution-policy section. ## Test plan - `git diff --check` and targeted policy/link checks pass. - Reviewed the complete diff and contributor, collaborator, and private security-reporting paths. Documentation only; no SDK runtime, repository settings, or generated source changes. <!-- codex-thread: 01a0cc13-4a7c-7883-aa1d-cc4373a5f7af -->
1 parent 55de0fe commit c9f222f

3 files changed

Lines changed: 28 additions & 4 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
# Contributing to OpenAI Java SDK
22

3+
## Contribution policy
4+
5+
We welcome bug reports, feature requests, minimal reproductions, and root-cause
6+
analysis through [GitHub issues](https://github.com/openai/openai-java/issues).
7+
8+
**Pull requests are limited to repository collaborators. We do not accept pull
9+
requests from non-collaborators**, including documentation or example changes.
10+
If you are not a collaborator, please open an issue instead of preparing a pull
11+
request. Include the affected version, expected and actual behavior, and a small,
12+
sanitized reproduction when applicable.
13+
14+
Report suspected security vulnerabilities privately as described in
15+
[SECURITY.md](SECURITY.md), rather than in issues or pull requests.
16+
17+
The development and pull request instructions below are for maintainers and
18+
repository collaborators.
19+
320
## Setting up the environment
421

522
This repository uses [Gradle](https://gradle.org/) with Kotlin DSL for building and dependency

‎README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2075,3 +2075,10 @@ changing the last available artifact may be a minor release.
20752075
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
20762076

20772077
We are keen for your feedback; please open an [issue](https://www.github.com/openai/openai-java/issues) with questions, bugs, or suggestions.
2078+
2079+
## Contributing
2080+
2081+
Please share bug reports and feature requests through [GitHub issues](https://github.com/openai/openai-java/issues).
2082+
Pull requests are limited to repository collaborators; we do not accept pull requests from non-collaborators.
2083+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for the contribution policy and development guide.
2084+
For security vulnerabilities, follow [SECURITY.md](SECURITY.md).

‎docs/architecture/security-model.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ webhook delivery are services outside this repository.
1818

1919
| Component | Purpose and important flow | Evidence |
2020
| --- | --- | --- |
21-
| openai-java-core | Transport-neutral client, generated services and models, request construction, authentication headers, retry/logging wrappers, JSON/SSE parsing, and webhook verification. | CONTRIBUTING.md:48-55; openai-java-core/src/main/kotlin/com/openai/client/OpenAIClientImpl.kt:57-140; openai-java-core/src/main/kotlin/com/openai/core/ClientOptions.kt:747-808 |
22-
| openai-java-client-okhttp | Default HTTP transport, caller-configurable proxy, redirects, timeouts, TLS, and hostname verification. | CONTRIBUTING.md:56-59; openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClient.kt:54-65; openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OkHttpClient.kt:180-242 |
23-
| openai-java | Umbrella artifact exposing core and OkHttp APIs without its own logic. | CONTRIBUTING.md:60-63; openai-java/build.gradle.kts:1-8 |
24-
| openai-java-bedrock | Optional Bedrock endpoint selection and bearer or AWS SigV4 authentication. | CONTRIBUTING.md:60-63; openai-java-bedrock/src/main/kotlin/com/openai/bedrock/BedrockAuth.kt:64-215 |
21+
| openai-java-core | Transport-neutral client, generated services and models, request construction, authentication headers, retry/logging wrappers, JSON/SSE parsing, and webhook verification. | CONTRIBUTING.md:69-72; openai-java-core/src/main/kotlin/com/openai/client/OpenAIClientImpl.kt:57-140; openai-java-core/src/main/kotlin/com/openai/core/ClientOptions.kt:747-808 |
22+
| openai-java-client-okhttp | Default HTTP transport, caller-configurable proxy, redirects, timeouts, TLS, and hostname verification. | CONTRIBUTING.md:73-75; openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClient.kt:54-65; openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OkHttpClient.kt:180-242 |
23+
| openai-java | Umbrella artifact exposing core and OkHttp APIs without its own logic. | CONTRIBUTING.md:76-78; openai-java/build.gradle.kts:1-8 |
24+
| openai-java-bedrock | Optional Bedrock endpoint selection and bearer or AWS SigV4 authentication. | CONTRIBUTING.md:79-80; openai-java-bedrock/src/main/kotlin/com/openai/bedrock/BedrockAuth.kt:64-215 |
2525
| Build and release workflows | Unprivileged PR validation and separately gated main-only release/publish jobs. | .github/workflows/ci.yml:3-24; .github/workflows/create-releases.yml:3-25 |
2626

2727
Most SDK sources are generated, but generated and hand-written tracked files are

0 commit comments

Comments
 (0)