EIPs icon indicating copy to clipboard operation
EIPs copied to clipboard

EIP-1: propose to adopt RFC 8174 (updates 2119)

Open xinbenlv opened this issue 2 years ago • 5 comments

RFC 2119 is updated by 8174. Have we discussed whether or not to adopt 8174?

xinbenlv avatar Aug 16 '22 14:08 xinbenlv

Hi! I'm a bot, and I wanted to automerge your PR, but couldn't because of the following issue(s):


(fail) eip-1.md

classification
updateEIP
  • Changes to EIP 1 require at least 5 unique approvals from editors; there's currently 1 approvals; the remaining editors are @axic, @pandapip1, @lightclient, @gcolvin

(fail) eip-template.md

classification
ambiguous
  • 'eip-template.md' must be in eip-###.md format; this error will be overwritten upon relevant editor approval

eth-bot avatar Aug 16 '22 14:08 eth-bot

The EIP template should be updated if this change is made.

Pandapip1 avatar Aug 16 '22 16:08 Pandapip1

@Pandapip1 updated eip-template.md

Now

  1. Request to remove label waiting: EIP number
  2. Request for review and merge

xinbenlv avatar Aug 18 '22 00:08 xinbenlv

Request to remove label waiting: EIP number

Can't do it, it's automated. We're working on a fix.

Request for review and merge

:+1:

Pandapip1 avatar Aug 18 '22 00:08 Pandapip1

If there is no objection, and we have not fixed the bot yet, I'd suggest a manual merge so new EIPs can start using RFC 8174

xinbenlv avatar Aug 19 '22 04:08 xinbenlv

@eth-bot please merge

xinbenlv avatar Sep 05 '22 17:09 xinbenlv

I think we're just waiting on three more approvals.

SamWilsn avatar Sep 06 '22 15:09 SamWilsn

Oh, I see, it was not obvious to me that it is waiting for three more approval for updating EIP-1, @SamWilsn

as it shows

2022-09-06_11-26-32

Could you grant your approvals? @axic @lightclient @gcolvin

xinbenlv avatar Sep 06 '22 15:09 xinbenlv

Is there a reason you don't update the actual RFC number in the anchor?

lightclient avatar Sep 06 '22 15:09 lightclient

I'm generally OK with this, but if would cause a less clutter as a footnote. I'd be even happier to make this a general policy that applies to all EIPs, and doesn't need to be repeated in every one of them.

gcolvin avatar Sep 06 '22 16:09 gcolvin

I'd be even happier to make this a general policy that applies to all EIPs, and doesn't need to be repeated in every one of them.

Let's do the less restrictive version first. I'm also in favor of this, but in the interest of moving something forward let's get this merged first.

Pandapip1 avatar Sep 06 '22 17:09 Pandapip1

I'd be even happier to make this a general policy that applies to all EIPs, and doesn't need to be repeated in every one of them.

Let's do the less restrictive version first. I'm also in favor of this, but in the interest of moving something forward let's get this merged first.

Can we at least move it to an endnote? It's just clutter when dropped into the middle of the most important part of an EIP.

gcolvin avatar Sep 06 '22 18:09 gcolvin

Is there a reason you don't update the actual RFC number in the anchor?

Which anchor? Could you share the screenshot of what you refer to?

xinbenlv avatar Sep 06 '22 19:09 xinbenlv

Can we at least move it to an endnote? It's just clutter when dropped into the middle of the most important part of an EIP.

@gcolvin I agree with you. I am just not sure markdown syntax supports endnote as well as LaTex etc. Would it be ok to you if I update it in a followup PR? We can update the policy in EIP-1 first. In a follow up PR we can address the formatting of endnote or footnote in the eip-template.md without all editors' approval, I am assuming?

xinbenlv avatar Sep 06 '22 19:09 xinbenlv

GFM supports footnotes like this[^1]

[^1]: hello

GFM supports footnotes like this^1

SamWilsn avatar Sep 16 '22 16:09 SamWilsn

GFM supports footnotes like this

Does CommonMark?

Pandapip1 avatar Sep 16 '22 18:09 Pandapip1

I'm generally OK with this, but if would cause a less clutter as a footnote. I'd be even happier to make this a general policy that applies to all EIPs, and doesn't need to be repeated in every one of them.

Got it. Do you mind I get the policy approved (EIP-1) first, and then I can work on the footnoting on a separate PRs e.g. updating the template, which requires less editor approval I'm assuming?

xinbenlv avatar Sep 26 '22 20:09 xinbenlv

@axic @lightclient IIUC this proposal require your editor approval too. Could you share your feedback or approval?

xinbenlv avatar Sep 26 '22 20:09 xinbenlv

Are we going to update all the EIPs that only refer to RFC 2119?

lightclient avatar Oct 03 '22 14:10 lightclient

Are we going to update all the EIPs that only refer to RFC 2119?

@lightclient I don't think it's necessary to update all existing EIPs.

I think we can just update the template so new EIPs will gradually adopt it. Also RFC 2119 or RFC 8174 are both recommendations not requirements so if some author want to opt-out they shall have the freedom to do so. (even EIP-1 itself didn't adopt it as far as I know.)

xinbenlv avatar Oct 04 '22 01:10 xinbenlv

Friendly ping @axic for last approval

xinbenlv avatar Oct 04 '22 01:10 xinbenlv

@gcolvin also need your approval. I will move it to footnote in a separate PR addressing the format on eip-template.md if that's the only concern from you.

xinbenlv avatar Oct 04 '22 01:10 xinbenlv

Are we going to update all the EIPs that only refer to RFC 2119?

This is only a suggestion. EIPs are free to use or not use it. I know the general gist of RFC 8174 and it seems like generally a good idea, but requiring it for past EIPs would actually be a normative change in some cases.

Pandapip1 avatar Oct 04 '22 11:10 Pandapip1

Discussed EIPIP meeting 66 and editors on the call @SamWilsn @lightclient are ok to merge this PR with update that removes links from eip-template.md for now until EIPW updates.

xinbenlv avatar Oct 05 '22 14:10 xinbenlv

Thanks @SamWilsn, LGTM

xinbenlv avatar Oct 08 '22 01:10 xinbenlv