TIP-000: TIP Purpose and Guidelines

Author(s): @TigrisOfGaul

What is a TIP?

TIP stands for Tarot Improvement Proposal, which has been adapted from the YIP (Yearn Improvement Proposal). The purpose of this process is to ensure changes to Tarot are transparent and well governed. A TIP is a design document providing information to the Tarot community about a proposed change to the system. The appropriate forum to gauge interest around a TIP is the Tarot Discord.

TIP Rationale

We intend TIPs to be the primary mechanisms for proposing new features, collecting community input on an issue, and for documenting the design decisions for changes to Tarot.

It is highly recommended that a single TIP contain a single key proposal or new idea. The more focused the TIP, the more successful it is likely to be.

A TIP must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement.

What belongs in a successful TIP?

Each TIP should have the following parts:

• Title - Provide a short descriptive title. The title should be 44 characters or less.
• Summary - Provide a simplified and accessible 1-2 sentence explanation of the TIP.
• Abstract - Provide a short (~200 word) description of the TIP.
• Motivation (optional) - Provide a clear explanation of the motivation, current Situation, or opportunity being addressed by the TIP. TIP submissions without sufficient motivation may be rejected outright.
• Specification (optional) - Provide a detailed explanation of the TIP.
• Rationale (optional) - 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. The rationale may also provide evidence of consensus within the Tarot community, and should discuss important objections or concerns raised during discussion.
• Copyright Waiver - All TIPs must be in the public domain. See the bottom of this TIP for an example copyright waiver.

TIP Editors

The current TIP editors are:

* Tigris of Gaul (@TigrisOfGaul)

TIP Editor Responsibilities

For each new TIP, an editor does the following:

• Read the TIP to check if it is ready: sound and complete. The ideas must make technical sense, even if they do not seem likely to get to final status.
• The title should accurately describe the content.
• Check the TIP for language (spelling, grammar, sentence structure, etc.), markup, and style.

If the TIP is not ready, the editor will send it back to the author for revision, with specific instructions.

Once the TIP is ready for prime time, the TIP editor will assign a TIP number and send a message back to the TIP author with next steps.

The TIP editors monitor TIP changes, and correct any structure, grammar, spelling, or markup mistakes we see.

The TIP editors do not pass judgment on TIPs. They merely do the administrative and editorial work.

History

The TIP document was derived heavily from the YIP Yearn Improvement Proposal document, and in many places text was simply copied and modified. Any comments about the TIP document should be directed to the TIP editors.

Copyright

Copyright and related rights waived via CC0.