Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Use a virtual environment to isolate dependencies:
- `python .github/scripts/check_notebooks.py` to validate notebook structure before pushing

## Coding Style & Naming Conventions
Write Python to PEP 8 with four-space indentation, descriptive variable names, and concise docstrings that explain API usage choices. Name new notebooks with lowercase, dash-or-underscore-separated phrases that match their directory—for example `examples/gpt-5/prompt-optimization-cookbook.ipynb`. Keep markdown cells focused and prefer numbered steps for multi-part workflows. Store secrets in environment variables such as `OPENAI_API_KEY`; never hard-code keys inside notebooks.
Write Python to PEP 8 with four-space indentation, descriptive variable names, and concise docstrings that explain API usage choices. Name new notebooks with lowercase, dash-or-underscore-separated phrases that match their directory—for example `examples/prompting/prompt-optimization-cookbook.ipynb`. Keep markdown cells focused and prefer numbered steps for multi-part workflows. Store secrets in environment variables such as `OPENAI_API_KEY`; never hard-code keys inside notebooks.

## Testing Guidelines
Execute notebooks top-to-bottom after installing dependencies and clear lingering execution counts before committing. For Python modules or utilities, include self-check cells or lightweight `pytest` snippets and show how to run them (for example, `pytest examples/object_oriented_agentic_approach/tests`). When contributions depend on external services, mock responses or gate the cells behind clearly labeled opt-in flags.
Expand Down
26 changes: 13 additions & 13 deletions registry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# authors for each page.

- title: GPT-5-Codex Prompting Guide
path: examples/gpt-5-codex_prompting_guide.ipynb
path: examples/prompting/gpt-5-codex_prompting_guide.ipynb
date: 2025-09-23
authors:
- daveleo-openai
Expand Down Expand Up @@ -42,7 +42,7 @@
- codex

- title: Realtime Prompting Guide
path: examples/Realtime_prompting_guide.ipynb
path: examples/prompting/Realtime_prompting_guide.ipynb
date: 2025-08-28
authors:
- minh-hoque
Expand Down Expand Up @@ -84,7 +84,7 @@
- gpt-oss-local

- title: GPT-5 Prompt Migration and Improvement Using the New Optimizer
path: examples/gpt-5/prompt-optimization-cookbook.ipynb
path: examples/prompting/prompt-optimization-cookbook.ipynb
date: 2025-08-07
authors:
- rajpathak-openai
Expand All @@ -96,7 +96,7 @@
- prompt-optimization

- title: GPT-5 prompting guide
path: examples/gpt-5/gpt-5_prompting_guide.ipynb
path: examples/prompting/gpt-5_prompting_guide.ipynb
date: 2025-08-07
authors:
- anoop-openai
Expand Down Expand Up @@ -249,7 +249,7 @@
- audio

- title: Optimize Prompts
path: examples/Optimize_Prompts.ipynb
path: examples/prompting/Optimize_Prompts.ipynb
date: 2025-07-14
authors:
- corwin
Expand All @@ -271,7 +271,7 @@
- automation

- title: Prompt Migration Guide
path: examples/Prompt_migration_guide.ipynb
path: examples/prompting/Prompt_migration_guide.ipynb
date: 2025-06-26
authors:
- minh-hoque
Expand Down Expand Up @@ -342,7 +342,7 @@
- mutli-agent-collaboration

- title: o3/o4-mini Function Calling Guide
path: examples/o-series/o3o4-mini_prompting_guide.ipynb
path: examples/prompting/o3o4-mini_prompting_guide.ipynb
date: 2025-05-26
authors:
- billchen-openai
Expand Down Expand Up @@ -796,7 +796,7 @@
- embeddings

- title: Unit test writing using a multi-step prompt
path: examples/Unit_test_writing_using_a_multi-step_prompt.ipynb
path: examples/prompting/Unit_test_writing_using_a_multi-step_prompt.ipynb
date: 2022-11-15
authors:
- ted-at-openai
Expand All @@ -805,7 +805,7 @@

- title: Unit test writing using a multi-step prompt with legacy Completions
path: >-
examples/Unit_test_writing_using_a_multi-step_prompt_with_older_completions_API.ipynb
examples/prompting/Unit_test_writing_using_a_multi-step_prompt_with_older_completions_API.ipynb
date: 2023-05-19
authors:
- ted-at-openai
Expand Down Expand Up @@ -875,7 +875,7 @@
archived: true

- title: Whisper prompting guide
path: examples/Whisper_prompting_guide.ipynb
path: examples/prompting/Whisper_prompting_guide.ipynb
date: 2023-06-27
authors:
- prestontuggle
Expand Down Expand Up @@ -2153,7 +2153,7 @@
- completions

- title: Prompt Caching 101
path: examples/Prompt_Caching101.ipynb
path: examples/prompting/Prompt_Caching101.ipynb
date: 2024-10-01
authors:
- charuj
Expand Down Expand Up @@ -2194,7 +2194,7 @@
- audio

- title: Enhance your prompts with meta prompting
path: examples/Enhance_your_prompts_with_meta_prompting.ipynb
path: examples/prompting/Enhance_your_prompts_with_meta_prompting.ipynb
date: 2024-10-23
authors:
- teomusatoiu
Expand Down Expand Up @@ -2377,7 +2377,7 @@
- chatgpt-productivity

- title: GPT-4.1 Prompting Guide
path: examples/gpt4-1_prompting_guide.ipynb
path: examples/prompting/gpt4-1_prompting_guide.ipynb
date: 2025-04-14
authors:
- nm-openai
Expand Down