Conversation
lightclient
force-pushed
the
add-simple-summary
branch
from
8ab902a to
92a1a2d
Compare
|
Hi! I'm a bot, and I wanted to automerge your PR, but couldn't because of the following issue(s): |
| Each EIP should have the following parts: | ||
|
|
||
| - Preamble - RFC 822 style headers containing metadata about the EIP, including the EIP number, a short descriptive title (limited to a maximum of 44 characters), and the author details. See [below](./eip-1.md#eip-header-preamble) for details. | ||
| - Simple Summary (*optional) - A short (~1 sentence) non-technical summary of the EIP. |
There was a problem hiding this comment.
We have been enforcing this as non-optional. What is the argument for optionality? Having it required means that someone building a table of EIPs can rely on its presence for a sub-title/short description.
There was a problem hiding this comment.
Small EIP generally don't benefit both (e.g. EIP-3541). I don't think there is much value in someone building a table of EIPs with short summaries, because I'd like to move away from EIPs as they are today anyways.
There was a problem hiding this comment.
While I agree with your desire to move away from EIPs in general, I am concerned that such things won't come to fruition for quite some time due to resource constraints. I'm hesitant to make decisions that assume "this repository is dying anyway, we don't need to worry about long term maintenance/planning" until such time as there is a clear end of life schedule for it.
There was a problem hiding this comment.
See #3564 (comment) for my argument for why I believe Simple Summary is valuable even when it mirrors the Abstract. If anything, I would rather remove the Abstract in the case of duplication, though I believe that having both is valuable even if they overlap.
|
There has been no activity on this pull request for two months. It will be closed in a week if no further activity occurs. If you would like to move this EIP forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review. |
|
This pull request was closed due to inactivity. If you are still pursuing it, feel free to reopen it and respond to any feedback or request a review in a comment. |
|
This was replaced by #3706. |
4 participants
For quite a while, simple summary has been an optional section in EIPs. This formalizes that in EIP-1. This would close #3564.