Improve onboarding & examples for openai-agents-python#2934
Improve onboarding & examples for openai-agents-python#2934sharkello wants to merge 1 commit intoopenai:mainfrom
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b57bcb532f
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| - Add 1–3 small examples in an folder showing the most common use cases. | ||
| - Add a template and 3 ready‑to‑assign small tasks to attract contributors. |
There was a problem hiding this comment.
Replace empty placeholders with concrete paths/labels
Several bullets leave key nouns blank (for example, an folder, Add a template, and issue labels shown as ,), so readers cannot tell what to create or how to tag issues. Because this file’s purpose is to provide actionable onboarding improvements, these unresolved placeholders make the guidance ambiguous and likely unusable for first-time contributors.
Useful? React with 👍 / 👎.
Title: Improve onboarding & examples for openai-agents-python
Summary
Adds IMPROVEMENTS.md with concrete suggestions to improve discoverability and onboarding: TL;DR, quickstart, and good‑first issues.
What changed
How to test
Risk
Low — documentation only.
Notes
I can prepare the example files and open a PR with these changes applied directly to README and examples if you want me to push and create PRs.