Skip to content

Improve onboarding & examples for openai-agents-python#2934

Closed
sharkello wants to merge 1 commit intoopenai:mainfrom
sharkello:sharkello/improve-readme-20260417
Closed

Improve onboarding & examples for openai-agents-python#2934
sharkello wants to merge 1 commit intoopenai:mainfrom
sharkello:sharkello/improve-readme-20260417

Conversation

@sharkello
Copy link
Copy Markdown

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

  • Added IMPROVEMENTS.md with a one‑line TL;DR, suggested examples, and good‑first‑issue templates.

How to test

  • Review IMPROVEMENTS.md in the repo root. Validate suggestions are clear and actionable.

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.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread IMPROVEMENTS.md
Comment on lines +11 to +12
- 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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

@seratch seratch closed this Apr 17, 2026
@sharkello sharkello deleted the sharkello/improve-readme-20260417 branch April 18, 2026 18:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants