[codex] Add open-source README overview#51
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0dcd1c1873
ℹ️ 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.
Replace the non-existent editable install extra
In this repo as checked out for this review, there is no pyproject.toml, setup.py, or setup.cfg anywhere under the project, so the new Quick start command fails before installing dependencies (python -m pip install -e '.[test]' reports that the directory does not appear to be a Python project). New contributors following the top-of-README path will be blocked from running tests; the existing CI and lower README sections instead install from requirements-lock.txt/requirements.txt.
Useful? React with 👍 / 👎.
Summary
Validation
git diff --checkNotes
This PR is documentation-only and does not change runtime behavior, workflows, credentials, or strategy defaults.