Archives
/
openai-cookbook
mirror of https://github.com/openai/openai-cookbook
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
main
revert-1014-origin/jbeutler/embeddings-sdk-update
charu/assistants_streaming
ankur/fix-pinecone-embeddings-notebook
katia/pdf-analysis
james/sdk_updates
james/quick_fix_notebook
katia/graphdb
colin/testing_sql_generation
jhills20-patch-1
james/making_slides
colin/guardrails
james/even_more_sdk_updates
feature/rz/UpdateToUsePythonSDK
ilan/assistants_overview_bugs
ilan/assistants_api_overview
applied-research/custom-tokenizer-model
ilan/structured_output
shyamal-chained-func-spec
chained-func-calling
cathykc/add-py-file
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'bcbb505a4a'
${ noResults }
openai-cookbook/.github/pull_request_template.md

1.8 KiB
Raw Blame History

Summary

Briefly describe the changes and the goal of this PR. Make sure the PR title summarizes the changes effectively.

Motivation

Why are these changes necessary? How do they improve the cookbook?

For new content

When contributing new content, read through our contribution guidelines, and mark the following action items as completed:

  • I have added a new entry in registry.yaml (and, optionally, in authors.yaml) so that my content renders on the cookbook website.
  • I have conducted a self-review of my content based on the contribution guidelines:
    • Relevance: This content is related to building with OpenAI technologies and is useful to others.
    • Uniqueness: I have searched for related examples in the OpenAI Cookbook, and verified that my content offers new insights or unique information compared to existing documentation.
    • Spelling and Grammar: I have checked for spelling or grammatical mistakes.
    • Clarity: I have done a final read-through and verified that my submission is well-organized and easy to understand.
    • Correctness: The information I include is correct and all of my code executes successfully.
    • Completeness: I have explained everything fully, including all necessary references and citations.

We will rate each of these areas on a scale from 1 to 4, and will only accept contributions that score 3 or higher on all areas. Refer to our contribution guidelines for more details.