Skip to content

Latest commit

 

History

History
53 lines (42 loc) · 2.63 KB

sep-template.md

File metadata and controls

53 lines (42 loc) · 2.63 KB

Preamble

SEP: To Be Assigned
Title: <SEP title>
Author: <list of authors' names, GitHub handles, and optionally, email addresses, separated by commas>
Track: <Informational or Standard>
Status: Draft
Created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
Updated: <date created or last updated, in ISO 8601 (yyyy-mm-dd) format>
Version: 0.1.0
Discussion: <link to where discussion for this SEP is taking place, typically the mailing list>

Simple Summary

"If you can't explain it simply, you don't understand it well enough." Provide a simplified and layman-accessible explanation of the SEP.

Dependencies

Should clearly list the dependencies this SEP has on other SEPs or CAPs. May go into further discussion about the circumstances of the dependency, although a list is sufficient.

Motivation

Should clearly explain why the existing protocol specification is inadequate to address the problem that the SEP solves. SEP submissions without sufficient motivation may be rejected outright.

Abstract

A short (~200 word) description of the technical issue being addressed.

Specification

The technical specification should describe the syntax and semantics of any new feature.

Design Rationale

The rationale fleshes out the specification by describing what motivated this particular design and why certain design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other protocols. The rationale may also provide evidence of consensus within the community, and should discuss important objections or concerns raised during discussion.

Security Concerns

All SEPs should carefully consider areas where security may be a concern, and document them accordingly. If a change does not have security implications, write "N/A".

Changelog

All SEPs should contain a changelog that succinctly lists its versions and what changes were introduced in each version. A complete description of what has changed should be included, but it should be as succinct as possible. Succinct is important so that over time a large changelog is easily digested.

Example:

  • v1.1.1: Fix misleading statements about the P parameter. #3499
  • v1.1.0: Add new paremeters to the X endpoint. #3498
  • v1.0.0: Updated status to Active. #1234
  • v0.2.0: Redesigned the API. #1004
  • v0.1.0: Initial draft. #1000