| tip | title | description | author | discussions-to | status | type | layer (*only required for Standards Track) | created | requires (*optional) | replaces (*optional) | superseded-by (*optional) |
|---|---|---|---|---|---|---|---|---|---|---|---|
<to be assigned> |
<The TIP title is a few words, not a complete sentence> |
<Description is one full (short) sentence> |
<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 <foo@bar.com>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)> |
<URL> |
Draft |
<Standards Track, Process, or Informational> |
<Core, Networking, Interface, IRC> |
<date created on, in ISO 8601 (yyyy-mm-dd) format> |
<TIP number(s)> |
<TIP number(s)> |
<TIP number(s)> |
This is the suggested template for new TIPs.
Note that an TIP number will be assigned by an editor. When opening a pull request to submit your TIP, please use an abbreviated title in the filename, tip-draft_title_abbrev.md.
The title should be 44 characters or less. It should not repeat the TIP number in title, irrespective of the category.
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.
The motivation section should describe the "why" of this TIP. What problem does it solve? Why should someone want to implement this standard? What benefit does it provide to the IOTA ecosystem? What use cases does this TIP address?
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
The technical specification 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 IOTA platforms (TODO: link to wiki).
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.
All TIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The TIP must explain how the author proposes to deal with these incompatibilities. TIP submissions without a sufficient backwards compatibility treatise may be rejected outright.
Test cases for an implementation are mandatory for TIPs that are affecting consensus changes. If the test suite is too large to reasonably be included inline, then consider adding it as one or more files in the TIPs directory.
An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification. If the implementation is too large to reasonably be included inline, then consider adding it as one or more files in the TIPs directory.
Copyright and related rights waived via CC0.