From e80d1df172f0fc793ed0965108028494f077839d Mon Sep 17 00:00:00 2001 From: Fouad Matin <169186268+fouad-openai@users.noreply.github.com> Date: Thu, 17 Apr 2025 17:19:30 -0700 Subject: [PATCH] add(.github): issue templates (#283) Add issue templates for: - Bug report - Docs issue --- .github/ISSUE_TEMPLATE/2-bug-report.yml | 51 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/3-docs-issue.yml | 27 +++++++++++++ README.md | 32 +++++++++------- 3 files changed, 96 insertions(+), 14 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/2-bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/3-docs-issue.yml diff --git a/.github/ISSUE_TEMPLATE/2-bug-report.yml b/.github/ISSUE_TEMPLATE/2-bug-report.yml new file mode 100644 index 00000000..bbcbcfa1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-bug-report.yml @@ -0,0 +1,51 @@ +name: 🪲 Bug Report +description: Report an issue that should be fixed +labels: + - bug + - needs triage +body: + - type: markdown + attributes: + value: | + Thank you for submitting a bug report. It helps make Codex better. + + If you need help or support using Codex, and are not reporting a bug, please + join our [Discussions](https://github.com/openai/codex/discussions), where you can ask questions or suggest ideas. + + Make sure you are running the [latest](https://npmjs.com/package/@openai/codex) version of Codex CLI. + The bug you are experiencing may already have been fixed. + + Please try to include as much information as possible. + + - type: input + attributes: + label: What version of Codex is running? + description: Copy the output of `codex --revision` + - type: input + attributes: + label: Which model were you using? + description: Like `gpt-4.1`, `o4-mini`, `o3`, etc. + - type: input + attributes: + label: What platform is your computer? + description: | + For MacOS and Linux: copy the output of `uname -mprs` + For Windows: copy the output of `"$([Environment]::OSVersion | ForEach-Object VersionString) $(if ([Environment]::Is64BitOperatingSystem) { "x64" } else { "x86" })"` in the PowerShell console + - type: textarea + attributes: + label: What steps can reproduce the bug? + description: Explain the bug and provide a code snippet that can reproduce it. + validations: + required: true + - type: textarea + attributes: + label: What is the expected behavior? + description: If possible, please provide text instead of a screenshot. + - type: textarea + attributes: + label: What do you see instead? + description: If possible, please provide text instead of a screenshot. + - type: textarea + attributes: + label: Additional information + description: Is there anything else you think we should know? \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/3-docs-issue.yml b/.github/ISSUE_TEMPLATE/3-docs-issue.yml new file mode 100644 index 00000000..456602e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-docs-issue.yml @@ -0,0 +1,27 @@ +name: 📗 Documentation Issue +description: Tell us if there is missing or incorrect documentation +labels: [docs] +body: + - type: markdown + attributes: + value: | + Thank you for submitting a documentation request. It helps make Codex better. + - type: dropdown + attributes: + label: What is the type of issue? + multiple: true + options: + - Documentation is missing + - Documentation is incorrect + - Documentation is confusing + - Example code is not working + - Something else + - type: textarea + attributes: + label: What is the issue? + validations: + required: true + - type: textarea + attributes: + label: Where did you find it? + description: If possible, please provide the URL(s) where you found this issue. \ No newline at end of file diff --git a/README.md b/README.md index 5b4b28e2..bcfbf4f4 100644 --- a/README.md +++ b/README.md @@ -119,11 +119,11 @@ And it's **fully open-source** so you can see and contribute to how it develops! Codex lets you decide _how much autonomy_ the agent receives and auto-approval policy via the `--approval-mode` flag (or the interactive onboarding prompt): -| Mode | What the agent may do without asking | Still requires approval | -| ------------------------- | ----------------------------------------------- | --------------------------------------------------------------- | -| **Suggest**
(default) | • Read any file in the repo | • **All** file writes/patches
• **All** shell/Bash commands | -| **Auto Edit** | • Read **and** apply‑patch writes to files | • **All** shell/Bash commands | -| **Full Auto** | • Read/write files
• Execute shell commands | – | +| Mode | What the agent may do without asking | Still requires approval | +| ------------------------- | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| **Suggest**
(default) | • Read any file in the repo | • **All** file writes/patches
• **Any** arbitrary shell commands (aside from reading files) | +| **Auto Edit** | • Read **and** apply‑patch writes to files | • **All** shell commands | +| **Full Auto** | • Read/write files
• Execute shell commands (network disabled, writes limited to your workdir) | – | In **Full Auto** every command is run **network‑disabled** and confined to the current working directory (plus temporary files) for defense‑in‑depth. Codex @@ -302,12 +302,23 @@ In 2021, OpenAI released Codex, an AI system designed to generate code from natu
-How do I stop Codex from touching my repo? +
+Which models are supported? -Codex always runs in a **sandbox first**. If a proposed command or file change looks suspicious you can simply answer **n** when prompted and nothing happens to your working tree. +Any model available with [Responses API](https://platform.openai.com/docs/api-reference/responses). The default is `o4-mini`, but pass `--model gpt-4.1` or set `model: gpt-4.1` in your config file to override.
+
+Why does o3 or o4-mini not work for me? +It's possible that your [API account needs to be verified](https://help.openai.com/en/articles/10910291-api-organization-verification) in order to start streaming responses and seeing chain of thought summaries from the API. If you're still running into issues, please let us know! + +
+How do I stop Codex from editing my files? + +Codex runs model-generated commands in a sandbox. If a proposed command or file change doesn't look right, you can simply type **n** to deny the command or give the model feedback. + +
Does it work on Windows? @@ -315,13 +326,6 @@ Not directly. It requires [Windows Subsystem for Linux (WSL2)](https://learn.mic
-
-Which models are supported? - -Any model available with [Responses API](https://platform.openai.com/docs/api-reference/responses). The default is `o4-mini`, but pass `--model gpt-4o` or set `model: gpt-4o` in your config file to override. - -
- --- ## Zero Data Retention (ZDR) Organization Limitation