[codex] Add open-source README overview#64
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c63c02cb09
ℹ️ About Codex in GitHub
Your team has set up Codex to 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 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ### Quick start | ||
|
|
||
| - `python -m pip install -e '.[test]'` |
There was a problem hiding this comment.
Fix the quick-start extra before publishing it
In a fresh checkout this command does not install pytest, because pyproject.toml defines no test extra (pytest only appears in requirements.txt). Pip will install the package without those test dependencies, so the next documented step, python -m pytest -q, can fail for users following the README exactly unless pytest already happens to be installed.
Useful? React with 👍 / 👎.
Summary
Validation
git diff --checkNotes
This PR is documentation-only and does not change runtime behavior, workflows, credentials, or strategy defaults.