From 57ab1057a3231f6820227522a2c40ca3ae452e0f Mon Sep 17 00:00:00 2001 From: Chris Busillo Date: Sun, 31 May 2026 10:41:28 -0400 Subject: [PATCH] docs(product): finish Every Code wording audit --- .github/ISSUE_TEMPLATE/1-codex-app.yml | 6 +-- .github/ISSUE_TEMPLATE/4-bug-report.yml | 4 +- .github/ISSUE_TEMPLATE/5-feature-request.yml | 10 ++--- .github/ISSUE_TEMPLATE/6-docs-issue.yml | 2 +- .github/workflows/README.md | 5 ++- AGENTS.md | 2 +- README.md | 5 +-- docs/config.md | 3 +- docs/upstream-import-policy.md | 40 ++++++++++---------- 9 files changed, 39 insertions(+), 38 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-codex-app.yml b/.github/ISSUE_TEMPLATE/1-codex-app.yml index 6e294ee27bc..b1be27b957d 100644 --- a/.github/ISSUE_TEMPLATE/1-codex-app.yml +++ b/.github/ISSUE_TEMPLATE/1-codex-app.yml @@ -1,5 +1,5 @@ -name: 🖥️ Codex App Bug -description: Report an issue with the Codex App +name: 🖥️ Every Code App Bug +description: Report an issue with the Every Code app labels: - app body: @@ -12,7 +12,7 @@ body: - type: input id: version attributes: - label: What version of the Codex App are you using (From “About Codex” dialog)? + label: What version of the Every Code app are you using? validations: required: true - type: input diff --git a/.github/ISSUE_TEMPLATE/4-bug-report.yml b/.github/ISSUE_TEMPLATE/4-bug-report.yml index 4de88414600..60994976210 100644 --- a/.github/ISSUE_TEMPLATE/4-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/4-bug-report.yml @@ -1,5 +1,5 @@ name: 🪲 Other Bug -description: Report an issue in Codex Web, integrations, or other Codex components +description: Report an issue in Every Code integrations or other components labels: - bug body: @@ -9,7 +9,7 @@ body: Before submitting a new issue, please search for existing issues to see if your issue has already been reported. If it has, please add a 👍 reaction (no need to leave a comment) to the existing issue instead of creating a new one. - If you need help or support using Codex and are not reporting a bug, please post on [codex/discussions](https://github.com/openai/codex/discussions), where you can ask questions or engage with others on ideas for how to improve codex. + If you need help or support using Every Code and are not reporting a bug, please post on [code/discussions](https://github.com/just-every/code/discussions), where you can ask questions or engage with others on ideas for how to improve Every Code. - type: textarea id: actual diff --git a/.github/ISSUE_TEMPLATE/5-feature-request.yml b/.github/ISSUE_TEMPLATE/5-feature-request.yml index 6ab4a893b4d..79d438e3aa4 100644 --- a/.github/ISSUE_TEMPLATE/5-feature-request.yml +++ b/.github/ISSUE_TEMPLATE/5-feature-request.yml @@ -1,12 +1,12 @@ name: 🎁 Feature Request -description: Propose a new feature for Code +description: Propose a new feature for Every Code labels: - enhancement body: - type: markdown attributes: value: | - Is Code missing a feature that you'd like to see? Feel free to propose it here. + Is Every Code missing a feature that you'd like to see? Feel free to propose it here. Before you submit a feature: 1. Search existing issues for similar features. If you find one, 👍 it rather than opening a new one. @@ -15,8 +15,8 @@ body: - type: input id: variant attributes: - label: What variant of Codex are you using? - description: (e.g., App, IDE Extension, CLI, Web) + label: What Every Code surface are you using? + description: (e.g., Every Code CLI, app, IDE integration, web) validations: required: true - type: textarea @@ -24,4 +24,4 @@ body: attributes: label: What feature would you like to see? validations: - required: true \ No newline at end of file + required: true diff --git a/.github/ISSUE_TEMPLATE/6-docs-issue.yml b/.github/ISSUE_TEMPLATE/6-docs-issue.yml index 1957b6035a5..5bc383933c9 100644 --- a/.github/ISSUE_TEMPLATE/6-docs-issue.yml +++ b/.github/ISSUE_TEMPLATE/6-docs-issue.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: value: | - Thank you for submitting a documentation request. It helps make Codex better. + Thank you for submitting a documentation request. It helps make Every Code better. - type: dropdown attributes: label: What is the type of issue? diff --git a/.github/workflows/README.md b/.github/workflows/README.md index f112206f969..cb3a844ee7d 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -1,10 +1,11 @@ # Workflow Strategy -Rust-specific `rust-ci*.yml` workflows are intentionally removed in this fork. +Rust-specific `rust-ci*.yml` workflows are intentionally removed for Every Code. ## Verification Paths -- `bazel.yml` is the primary Rust verification path for pull requests and for `main`. +- `./build-fast.sh` is the required local Rust verification gate. +- `preview-build.yml` builds preview binaries for pull requests. - `release.yml` is displayed in GitHub Actions as `Release Intent`. It runs after relevant `main` pushes, determines whether the committed `codex-cli/package.json` version has an existing `v` tag, and either diff --git a/AGENTS.md b/AGENTS.md index 061a7b2f7c6..0253697f251 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -39,7 +39,7 @@ Completion/build step - Policy: All errors AND all warnings must be fixed before you’re done. Treat any compiler warning as a failure and address it (rename unused vars with `_`, remove `mut`, delete dead code, etc.). - Do not run additional format/lint/test commands on completion (e.g., `just fmt`, `just fix`, `cargo test`) unless explicitly requested for a specific task. - ***NEVER run rustfmt*** -- Before pushing to `main`, run `./pre-release.sh` to mirror the release preflight (dev-fast build, CLI smokes, workspace nextest). +- Before release-bound work lands on `main`, run `./pre-release.sh` to mirror the release preflight (dev-fast build, CLI smokes, workspace nextest). Optional regression checks (recommended when touching the Rust workspace): diff --git a/README.md b/README.md index efd830bf5c5..c876267ffd8 100644 --- a/README.md +++ b/README.md @@ -342,9 +342,8 @@ The `pre-push` hook runs `./pre-release.sh` automatically when pushing to `main` 1. Fork the repository 2. Create a feature branch: `git checkout -b feature/amazing-feature` 3. Make your changes -4. Run tests: `cargo test` -5. Build successfully: `./build-fast.sh` -6. Submit a pull request +4. Build successfully: `./build-fast.sh` +5. Submit a pull request   diff --git a/docs/config.md b/docs/config.md index c7a117828ef..678898da56a 100644 --- a/docs/config.md +++ b/docs/config.md @@ -15,7 +15,8 @@ Every Code supports several mechanisms for setting config values: - Because quotes are interpreted by one's shell, `-c key="true"` will be correctly interpreted in TOML as `key = true` (a boolean) and not `key = "true"` (a string). If for some reason you needed the string `"true"`, you would need to use `-c key='"true"'` (note the two sets of quotes). - The `$CODE_HOME/config.toml` configuration file. `CODE_HOME` defaults to `~/.code`; Every Code also reads from `$CODEX_HOME`/`~/.codex` for backwards compatibility but only writes to `~/.code`. (Logs and other state use the same directory.) See [CODE and CODEX compatibility policy](./upstream-import-policy.md#code-and-codex-compatibility-policy) for naming and fallback rules. -- https://developers.openai.com/codex/config-reference +- Upstream compatibility reference: + https://developers.openai.com/codex/config-reference ## model diff --git a/docs/upstream-import-policy.md b/docs/upstream-import-policy.md index 2063ba13292..90d9d1175fa 100644 --- a/docs/upstream-import-policy.md +++ b/docs/upstream-import-policy.md @@ -117,7 +117,7 @@ outside the product branch and must be replayed. ### Upstream Review Cursors -Every Code is a long-running overlay product with two upstream references. Track +Every Code is a product branch with two upstream references. Track where review left off in `.github/upstream-cursors.json`, and inspect that state with: @@ -206,6 +206,25 @@ repo-owned and predictable: just local-remove-homebrew-code-link ``` +Then push the release metadata branch to `origin`, merge the release metadata +PR, and monitor the `Release Intent` workflow: + +```sh +git push origin HEAD +scripts/wait-for-gh-run.sh --workflow 'Release Intent' --branch main +``` + +A successful workflow run is not enough evidence that a release was published: +non-release runs also complete successfully as no-ops when the package version +already has a tag. When cutting a release, verify the tag or GitHub Release +directly after the workflow succeeds: + +```sh +gh release view v --repo cbusillo/code +``` + +Do not push Every Code releases to `upstream` or `openai`. + ## Local Cache Cleanup During active local work, keep rebuildable caches bounded while preserving the @@ -236,25 +255,6 @@ target cache buckets, and release dependency cache. It preserves Run without `--apply` to preview deletions. Use `--keep-release-cache` only when you intentionally want to preserve release dependency cache as well. -Then push the release metadata branch to `origin`, merge the release metadata -PR, and monitor the `Release Intent` workflow: - -```sh -git push origin HEAD -scripts/wait-for-gh-run.sh --workflow 'Release Intent' --branch main -``` - -A successful workflow run is not enough evidence that a release was published: -non-release runs also complete successfully as no-ops when the package version -already has a tag. When cutting a release, verify the tag or GitHub Release -directly after the workflow succeeds: - -```sh -gh release view v --repo cbusillo/code -``` - -Do not push Every Code releases to `upstream` or `openai`. - ## Fork Health Run this before and after upstream syncs: