You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/PR.md
+8-11Lines changed: 8 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,8 +18,8 @@ Write for senior engineers familiar with the SDK. Assume your reader:
18
18
Every PR description should have:
19
19
20
20
1.**Motivation** — Why is this change needed?
21
-
2.**Public API Changes** — What changes to the public API (with code examples)?
22
-
3.**Use Cases** (optional) — When would developers use this feature? Only include for non-obvious functionality; skip for trivial changes.
21
+
2.**Public API Changes** — What changes to the public API (with code snippets)?
22
+
3.**Use Cases** (optional) — When would developers use this feature? Only include for non-obvious functionality; skip for trivial changes or obvious fixes.
23
23
4.**Breaking Changes** (if applicable) — What breaks and how to migrate?
24
24
25
25
## Writing Principles
@@ -29,9 +29,9 @@ Every PR description should have:
29
29
- ✅ "The OpenAI SDK supports dynamic API keys, but we don't expose this capability"
30
30
- ❌ "Added ApiKeySetter type import from openai/client"
31
31
32
-
**Document public API changes with examples:**
32
+
**Document public API changes with example code snippets:**
33
33
34
-
- ✅ Show before/after code examples for API changes
34
+
- ✅ Show before/after code snippets for API changes
35
35
- ❌ List every file or line changed
36
36
37
37
**Be concise:**
@@ -117,7 +117,6 @@ const model = new OpenAIModel({
0 commit comments