search

neo-project / proposals

NEO Enhancement Proposals
Creative Commons Attribution 4.0 International
136 stars 113 forks source link

Draft NEP29: Standardization of NEP Number Assignment and Usage #172

Closed Jim8y closed 5 months ago

Jim8y commented 6 months ago

The current process for managing NEP numbers is cumbersome and inefficient, causing confusion and delays in the drafting and reviewing phases. Proposers often need to reference NEP numbers in their drafts and related documentation, but without a permanent number, this becomes a moving target until adoption. This NEP seeks to streamline the process by ensuring each draft receives a unique and final NEP number upon submission.

  1. NEP Number Assignment:

    • Upon submission of a draft NEP, a unique NEP number will be assigned immediately.
    • This number will be considered used, regardless of the draft’s final status (adopted or not).

  2. Usage of NEP Numbers:

    • Drafts must use their assigned NEP number in all references within the document.
    • When submitting a draft as a pull request (PR), the PR title must include the NEP number in the format: Draft NEP XX: [Title].
    • If a PR includes multiple drafts, the title format should be: Draft NEP XX and Draft NEP YY: [Title].
roman-khimov commented 6 months ago
  1. This doesn't require an additional NEP, NEP-1 is exactly for this purpose.
  2. Drafts can be NEPR-$PR_NUMBER, like NEPR-172 here. Much easier to separate from real NEPs, separate numbering.
Jim8y commented 6 months ago
  1. This doesn't require an additional NEP, NEP-1 is exactly for this purpose.
  2. Drafts can be NEPR-$PR_NUMBER, like NEPR-172 here. Much easier to separate from real NEPs, separate numbering.
  1. NEP-1 has no definition and regulation on managing the NEP number, otherwise there should not be a problem at all.
  2. What is the benifit of making it slightly more complex as using PR number? Cause you will not know your PR number until you open one.
  3. you still need to be assigned a NEP number that no one knows if that is already assigned but not yet merged.
  4. You still need to keep updating the file names and contents.

So, why?

superboyiii commented 5 months ago

At least I agree with @Jim8y at 2 points:

  1. Don't use NEPR number as NEP number, it breaks the way previous and make people confused when NEP-29 jump to NEP-123.
  2. NEP number needn't pick serial numbers, so every PR +1 makes sense.
Jim8y commented 5 months ago

and, using pr number means we have to update the pr again after we get sufficient approve, but that will dismiss all existing approve......while collecting approve can take multiple weeks or months.

shargon commented 5 months ago

and, using pr number means we have to update the pr again after we get sufficient approve, but that will dismiss all existing approve......while collecting approve can take multiple weeks or months.

That's right

Jim8y commented 5 months ago
  1. We have NEP-1 for these matters.
  2. I don't see it solving any real problem for us.

@roman-khimov Its ok, you can ignor it. There have being many cases i have to convince you hard, cause you are always like believe there is no problem at all.

Even if NEPs being there for many years can not be finished, even if multiple NEP numbers are assigned but we just can not know unless we keep checking every single one of those drafts, even if without this pr, new NEPs will have to keep updating the file name, the file content, related implementations, and dismiss all existing approvals, just because we dont know the NEP number or we have to keep updating the NEP number.

Its a mess of maintaining multiple NEP proposals already, can't you see it already? On the contrary, what harm or damage can this proposal cause to Neo?