Skip to content

Latest commit

 

History

History
61 lines (34 loc) · 2.01 KB

template.md

File metadata and controls

61 lines (34 loc) · 2.01 KB
title description draft
XXXX: Template
Template
true

XXXX: Template

NOTE: the file should be named _DRAFT_<your-title>.md and be placed in the docs/sources/lids directory. Once accepted, it will be assigned a LID number and the file will be renamed by the sponsor.
Remove this section before submitting, and retain the structure of this document.

Author: Name (email)

Date: MM/YYYY

Sponsor(s): @username of maintainer(s) willing to shepherd this LID

Type: Feature|Process

Status: Draft|In Discussion|Accepted|Rejected|Completed

Related issues/PRs:

Thread from mailing list:


Background

Describe the key facts and link to any documents, architecture diagrams or code. Keep this short, just a paragraph or two.

Problem Statement

Describe why the above is a problem we have now or will have in the future. Just a paragraph or two.

Goals

Describe the goals that we wish to achieve when considering the options available. Be clear about what is important and what could be left to the future. Non-goals are also useful to list here to clarify intent.

Non-Goals (optional)

What is out of scope for this proposal? Listing non-goals helps to focus discussion and make progress. Highlight anything that is being deferred to a later phase of implementation that may call for its own enhancement.

Proposals

List at least two possible ways of achieving the goals, these are typically different technical approaches that have differing trade-offs so summarise the trade-offs. “Do nothing” is typically worth considering too.

Proposal 0: Do nothing

Describe what happens if we do nothing, how bad does the problem become (over what time frame)?

Proposal 1: Title

Describe the first proposal, what are the benefits and trade-offs that this approach has?

Proposal n: Title

Describe the nth proposal(s), what are the benefits and trade-offs that these approaches have?

Other Notes