RFC 00000
RFC Format and Semantics
Authors
Izuru Yakumo
Status
Accepted
Prelude
The format used here is loosely based on the Tildeverse RFC system authored by Robert Miles a.k.a. khuxkm
Abstract
This RFC defines the format used by an RFC. RFCs in this system are written as Markdown and stored on this WriteFreely instance.
This RFC also defines the semantics of how such a system will work.
Format
The format MUST contain the following elements:
Title (level 2 heading): The title of the document.
Number (level 1 heading): The canonical number of an RFC. Starts as 00000 (this document) and counts up in decimal.
Author (level 2 heading): The author of the document, MAY contain an e-mail address.
Status (level 2 heading): The status of this document. Should be “Accepted” or “Proposed”. (“Rejected” documents are immediately removed from the system).
The following items MAY also be included, if necessary:
Updates (level 3 heading): A comma-separated list, which this RFC updates.
Updated by (level 3 heading): A comma-separated list, which update this RFC
Note that the two lists should be added to in sequence; if RFC 00002 updates RFC 00001, then RFC 00002 needs to have 00001 in its updates and RFC 00001 needs 00002 in its updated-by.
Semantics of the RFC system
The RFC system will be hosted at rfc.chaotic.ninja and on a repository located here
Types of documents
RFC documents are simply requests. They are for simple things like defining how something should work or how something should be done.
Submission guidelines
An RFC should be submitted by sending a patch to Izuru Yakumo's e-mail address. RFCs MUST come with a draft name.
For example, a draft name for an RFC to give a hostname to a server belonging to chaotic.ninja and/or kalli.st could be decide-on-a-hostname-for-a-server
The only time an RFC can omit the number tag in its structure is when it is a draft.
Drafts do not have numbers and are of the status “Proposed”.
If or when an RFC is accepted, it will be given a number (at which time it MUST be renamed rfc-XXXXX, where X is a number, as well as placing it as a level 1 header such as RFC [number]).
The status MUST be changed to Accepted and the number tag MUST contain the assigned number.
When the former draft meets these requirements, the patch will be merged into the repository.
Procedural Section
Every RFC and Standards document should end with a procedural information section (which MUST begin with a level 2 heading followed by the content)
There are two sub-sections to the procedural info section, both of which MUST be level 3 headings:
Configuration Considerations: For example, if configs need to be changed due to the RFC.
Security Considerations: If there are any security reasons/concerns for the document, they MUST be subsections of this.
Notes
The title MAY be a level 1 header instead, if the document does not have a number.
Subheadings belonging to “Security Considerations” MUST be level 4 headings.
Procedural Information
Security Considerations
There are no security considerations in this document.
Configuration Considerations
A subdomain of chaotic.ninja has been provisioned and a WriteFreely single user instance, alongside the Git in accordance with this document.