Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 3.52 KB

README.md

File metadata and controls

58 lines (38 loc) · 3.52 KB
ACP 84
Title Table Preamble for ACPs
Author(s) Gauthier Leonard (@Nuttymoon)
Status Activated
Track Meta

Abstract

The current ACP template features a plain-text code block containing "RFC 822 style headers" as Preamble (see What belongs in a successful ACP?). This header includes multiple links to discussions, authors, and other ACPs.

This ACP proposes to replace the Preamble code block with a Markdown table format (similar to what is used in Ethereum EIPs).

Motivation

The current ACPs Preamble is (i) not very readable and (ii) not user-friendly as links are not clickable. The proposed table format aims to fix these issues.

Specification

The following Markdown table format is proposed:

ACP PR Number
Title ACP title
Author(s) A list of the author's name(s) and optionally contact info: FirstName LastName (@GitHubUsername or email@address.com)
Status Proposed, Implementable, Activated, Stale (Discussion)
Track Standards, Best Practices, Meta, Subnet
Replaces (*optional) ACP-XX
Superseded-By (*optional) ACP-XX

It features all the existing fields of the current ACP template, and would replace the current Preamble code block in ACPs/TEMPLATE.md.

Backwards Compatibility

Existing ACPs could be updated to use the new table format, but it is not mandatory.

Reference Implementation

For this ACP, the table would look like this:

ACP 84
Title Table Preamble for ACPs
Author(s) Gauthier Leonard (@Nuttymoon)
Status Proposed (Discussion)
Track Meta

Security Considerations

NA

Open Questions

NA

Copyright

Copyright and related rights waived via CC0.