Skip to content

Instantly share code, notes, and snippets.

@muellerzr
Created April 5, 2022 20:10
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save muellerzr/990ca94182825c08aef213c57d032b2c to your computer and use it in GitHub Desktop.
Save muellerzr/990ca94182825c08aef213c57d032b2c to your computer and use it in GitHub Desktop.
My personal PR template that I'll be experimenting with for the next few months

{feature_name}

What does this add?

{summary}

Who is it for?

{audience/issues closed}

Why is it needed?

{needed}

What parts of the API does this impact?

User-facing:

{parts of main API that gets modified, not examples}

Internal structure:

{any non-user-facing behavior changes, not examples}

Basic Usage Example(s):

{examples}

When would I use it, and when wouldn't I?

{usage_cases}

Does a similar feature exist? If so, why is this better?

{name of original feature}

Pros of original feature

{2-3 thought out pros if possible}

Cons of original feature

{2-3 thought out cons if possible}

Pros of new feature, relative to the original

{2-3 thought out pros if possible}

Cons of new feature, relative to the original

{2-3 thought out cons if possible}

Anticipated maintence burden? (What will happen in say, 3 months if something changes)

{2-3 sentences discussing library changes, test impacts, etc}

@muellerzr
Copy link
Author

To use this with gh:

gh pr create -t "Some title" --body "`echo "$(<~/pr_template.md)" | vipe`"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment