forked from openai/openai-cookbook
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add pull request template (openai#731)
- Loading branch information
1 parent
315ca59
commit ae460a8
Showing
1 changed file
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |