Skip to content

design-proposal-template.md

Latest commit

 

History

History
100 lines (73 loc) · 3.52 KB

design-proposal-template.md

File metadata and controls

100 lines (73 loc) · 3.52 KB
Raw

TODO: My Proposal

Instructions

  • Click "Copy raw file" on this template
  • Visit https://hackmd.io/new to create a new, blank doc
    • You should not need to sign in to do this, but you can if you like
  • Paste the copied template contents
  • Fill out the rest of the template
  • Ensure the sharing settings match this:
    • Read: Everyone
    • Write: Signed-in users or Write: Everyone
    • Engagement control: Commenting, Suggest edit, Emoji reply
  • Share a link to this doc in the #internals channel on the Sorbet Slack

You MAY deviate from this template if you think it improves the clarity of the proposal. For example: you may consider changing the section titles to one-line summaries of the problem, solution, etc. You may add additional sections or sub sections.

For more writing tips, see https://blog.jez.io/dont-bury-the-lede/

Note: Most of the writing prompts in this template are commented out—you may want to consider the "Raw" view when reading on GitHub.

  • Author(s): TODO
  • Organization: TODO (optional)

Problem

TODO

Proposed solution

TODO

Alternatives considered

TODO

Prior art

TODO

Edge cases and interactions

TODO