Skip to content

[codex] Add open-source README overview#64

Merged
Pigbibi merged 1 commit into
mainfrom
codex/readme-open-source-overview-20260603
Jun 3, 2026
Merged

[codex] Add open-source README overview#64
Pigbibi merged 1 commit into
mainfrom
codex/readme-open-source-overview-20260603

Conversation

@Pigbibi

@Pigbibi Pigbibi commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add a bilingual investment-risk notice near the top of the README.
  • Add an open-source oriented overview explaining what the repository does, current status, quick start, safe deploy/operation path, and evidence/performance boundary.
  • Keep the existing detailed runbooks and historical notes below the new entry section.

Validation

  • README coverage script checked Chinese and English risk notices plus overview, quick start, deploy/operate, and evidence sections.
  • git diff --check

Notes

This PR is documentation-only and does not change runtime behavior, workflows, credentials, or strategy defaults.

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

Copy link
Copy Markdown

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

Comment thread README.md

### Quick start

- `python -m pip install -e '.[test]'`

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

@Pigbibi Pigbibi merged commit 50b0034 into main Jun 3, 2026
1 check passed
@Pigbibi Pigbibi deleted the codex/readme-open-source-overview-20260603 branch June 3, 2026 08:00
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.

1 participant