Skip to content

Commit

Permalink
Add pull request template (openai#731)
Browse files Browse the repository at this point in the history
  • Loading branch information
simonpfish authored Sep 22, 2023
1 parent 315ca59 commit ae460a8
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## Summary

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

## Changes

List the major and minor changes.

- Major Changes
- ...
- Minor Changes
- ...

## Motivation

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

## Self Review Checklist

- [ ] Is the writing easily skimmable?
- Sections have informative titles.
- Key takeaways are upfront.
- Short paragraphs and topic sentences are used.
- [ ] Is the writing quality high?
- Sentences are simple and unambiguous.
- Demonstrative pronouns are avoided or clearly referenced.
- No left-branching sentences.
- [ ] Is the content universally helpful?
- Terminology is specific and avoids jargon.
- Provides solutions to common problems.
- Code examples are general and exportable.
- [ ] Is the content consistent?
- Styling and formatting align with existing documentation.
- Consistent use of punctuation and case.

**Note:** For additional guidelines on writing good documentation, check out [What Makes Documentation Good](https://cookbook.openai.com/what_makes_documentation_good).

0 comments on commit ae460a8

Please sign in to comment.