---). This header is also termed "front matter" by Jekyll. The headers must appear in the following order. Headers marked with "*" are optional and are described below. All other headers are required.
snip:SNIP number/name (this is determined by the SNIP editor)
author:a list of the author's or authors' name(s) and/or username(s), or name(s) and email(s). Details are below.
* discussions-to:a url pointing to the official discussion thread
status:Draft, Accepted, Final, Active, Abandoned, Rejected, or Superseded
* review-period-end:date review period ends
type:Standard, Meta, or Informational
created:date of creation
* updated:comma separated list of dates
* requires:SNIP number(s)
* replaces:SNIP number(s)
* superseded-by:SNIP number(s)
* resolution:a url pointing to the resolution of this SNIP
authorheader optionally lists the names, email addresses or usernames of the authors/owners of the SNIP. Those who prefer anonymity may use a username only, or a first name and a username. The format of the author header value must be:
Random J. User (@username)
Random J. User
discussions-toheader is necessary if the SNIP is being discussed privately with the author.
discussions-tocannot point to GitHub pull requests.
typeheader specifies the type of SNIP: Standards Track, Meta, or Informational.
categoryheader specifies the SNIP's category. This is required for standards-track SNIPs only.
createdheader records the date that the SNIP was assigned a number
updatedheader records the date(s) when the SNIP was updated with "substantial" changes. This header is only valid for SNIPs of Draft and Active status.
requiresheader, indicating the numbers of SNIPs on which this SNIP depends.
superseded-byheader indicating that a SNIP has been rendered obsolete by a later document; the value is the number of the SNIP that replaces the current document. The newer SNIP must have a
replacesheader containing the number of the SNIP that it rendered obsolete.
assetsfolder for that SNIP as follows:
assets/snip-N(where N is the SNIP number). When linking to an image in the SNIP, use relative links such as
Xis the SNIP's assigned number.