-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7325e1a
commit 8d69c2f
Showing
1 changed file
with
81 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
--- | ||
title: <The LIP title is a few words, not a complete sentence> | ||
description: <Description is one full (short) sentence> | ||
author: <a comma separated list of the author's or authors' name + GitHub username (in parenthesis), or name and email (in angle brackets). Example, FirstName LastName (@GitHubUsername), FirstName LastName <[email protected]>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)> | ||
discussions-to: <URL> | ||
status: Draft | ||
type: <Protocol, Lens Metadata Standard, or Lens Open Algorithm Standard> | ||
category: <Contracts, API, SDK> # Only required for Protocol. Otherwise, remove this field. | ||
created: <date created on, in ISO 8601 (yyyy-mm-dd) format> | ||
requires: <LIP number(s)> # Only required when you reference an LIP which is also dependent on this to work. Otherwise, remove this field. | ||
--- | ||
|
||
## Abstract | ||
|
||
<!-- | ||
The Abstract is a multi-sentence (short paragraph) technical summary. This should be a very terse and human-readable version of the specification section. Someone should be able to read only the abstract to get the gist of what this specification does. | ||
TODO: Remove this comment before submitting | ||
--> | ||
|
||
## Motivation | ||
|
||
<!-- | ||
This section is optional. | ||
The motivation section should include a description of any nontrivial problems the LIP solves. It should not describe how the LIP solves those problems, unless it is not immediately obvious. It should not describe why the LIP should be made into a standard, unless it is not immediately obvious. | ||
With a few exceptions, external links are not allowed. If you feel that a particular resource would demonstrate a compelling case for your LIP, then save it as a printer-friendly PDF, put it in the assets folder, and link to that copy. | ||
TODO: Remove this comment before submitting | ||
--> | ||
|
||
## Specification | ||
|
||
<!-- | ||
The Specification section should describe the syntax and semantics of any new feature. The specification should be detailed enough to allow competing, interoperable implementations for any of the current Lens platforms | ||
TODO: Remove this comment before submitting | ||
--> | ||
|
||
## Rationale | ||
|
||
<!-- | ||
The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages. | ||
The current placeholder is acceptable for a draft. | ||
TODO: Remove this comment before submitting | ||
--> | ||
|
||
TBD | ||
|
||
## Backwards Compatibility | ||
|
||
<!-- | ||
This section is optional. | ||
All LIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The LIP must explain how the author proposes to deal with these incompatibilities. LIP submissions without a sufficient backwards compatibility treatise may be rejected outright. | ||
The current placeholder is acceptable for a draft. | ||
TODO: Remove this comment before submitting | ||
--> | ||
|
||
No backward compatibility issues found. | ||
|
||
## Security Considerations | ||
|
||
<!-- | ||
All LIPs must contain a section that discusses the security implications/considerations relevant to the proposed change. Include information that might be important for security discussions, surfaces risks and can be used throughout the life cycle of the proposal. For example, include security-relevant design decisions, concerns, important discussions, implementation-specific guidance and pitfalls, an outline of threats and risks and how they are being addressed. LIP submissions missing the "Security Considerations" section will be rejected. An LIP cannot proceed to status "Final" without a Security Considerations discussion deemed sufficient by the reviewers. | ||
The current placeholder is acceptable for a draft. | ||
TODO: Remove this comment before submitting | ||
--> | ||
|
||
Needs discussion. | ||
|
||
## Copyright | ||
|
||
Copyright and related rights waived via CC0. |