Skip to content

Instantly share code, notes, and snippets.

@davecheney
Created February 13, 2019 20:23
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 davecheney/48c3271283211f4bfb557aedbc4dcae2 to your computer and use it in GitHub Desktop.
Save davecheney/48c3271283211f4bfb557aedbc4dcae2 to your computer and use it in GitHub Desktop.

Title

Status: {draft,in review, approved/declined}

Goals

  • goal one
  • goal two (optional)
  • goal three (pushing it, don't try to boil all the oceans in one sitting)

Non-goals

  • what doesn't it do
  • what is also out of scope

Background

why do we need to do this

High-Level Design

what needs to be changed

Detailed Design

how is it going to change

Alternatives Considered

what seemed like the right answer, but was flawed

Security Considerations

does this introduce a security risk, how is it mitigated?

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