Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 1.93 KB

TEMPLATE.md

File metadata and controls

61 lines (36 loc) · 1.93 KB

[This is a template for Hyperspace's design proposal process, documented here.]

Proposal: [Title]

Discussion at https://github.com/microsoft/hyperspace/XXXXX.

Abstract

[A short summary of the proposal.]

Background

[An introduction of the necessary background and the problem being solved by the proposed change.]

Proposal

[A precise statement of the proposed change.]

Rationale

[A discussion of alternate approaches and the trade offs, advantages, and disadvantages of the specified approach.]

Compatibility

[A discussion of the change with regard to the compatibility guidelines.]

Design

[A description of the proposed design/algorithm. This should include a discussion of how the work fits into Hyperspace's roadmap.]

Note: If you want to use any images, please upload the .svg AND .png/.jpg file them to /docs/design/img/ and link to them here.

Here's a sample image:

Sample image

Implementation

[A description of the steps in the implementation, who will do them, and when.]

Note: If you want to use any images, please upload the .svg AND .png/.jpg file them to /docs/design/img/ and link to them here.

Impact on Performance (if applicable)

[A discussion of impact on performance and any corner cases that the author is aware of. If there is a negative impact on performance, please make sure to capture an issue in the next section. This section may be omitted if there are none.]

Open issues (if applicable)

[A discussion of issues relating to this proposal for which the author does not know the solution. If you have already opened the corresponding issues, please link to them here. This section may be omitted if there are none.]