Template for `discussion-to` threads

EIPs
1

As announced here, I’d like to propose a default template we could suggest to EIP authors for their discussion-to threads on EthMagicians.

The template should be auto-populated when people create a new post in the EIPs category. We could potentially store this template in the ethereum/eips repo, too.

Here’s a first draft of what it could look like:

discussion-to Template

It is recommended to use the following template when creating a discussion-to thread for your EIP on ethereum-magicians.org.

Update Log

This section should list significant updates to the EIP as the specification evolves. The first entry should be the PR to create the EIP. The recommended format for log entries is:

For example, using EIP-1:

  • 2024-06-05: Enable external links to Chain Agnostic Improvement Proposals (CAIPs), commit 32dc740.
    …

External Reviews

This section should list notable reviews the EIP has received from the Ethereum community. These can include specific comments on this forum, timestamped audio/video exchanges, formal audits, or other external resources. This section should be the go-to for readers to understand the community’s current assessment of the EIP. Aim for neutrality, quality & thoroughness over “cherry-picking” the most favorable reviews.

The recommended format for entries is:

For example, using EIP-1559, one entry could be:

  • 2020-12-01: “An Economic Analysis of EIP-1559”, by Tim Roughgarden, full report

Outstanding Issues

This section should highlight outstanding issues about the EIP, and, if possible, link to forums where these are being addressed. This section should allow readers to quickly understand what the most important TODOs for the EIP are, and how to best contribute. Once issues are resolved, they should be checked off with a note giving context on the resolution.

The recommended format for new entries is:

Once issues are addressed, these becomes:

For example, using EIP-3675, one entry could be:

  • 2021-07-08: Repurpose the DIFFICULTY opcode, tracking issue
    • 2021-10-30: Introduce EIP-4399, EIP PR
4 Likes
2

A topic template for the EIPs category would be great. (also do similar for ERCs, but want to start somewhere).

We could also default the category to be wiki posts so that anyone can edit, removing the burden of maintaining from just the author.

1 Like
3

I’ve added this as the template for EIPs and Core EIPs

2 Likes