proposals icon indicating copy to clipboard operation
proposals copied to clipboard

Standardization of NEP Number Assignment and Usage

Open Jim8y opened this issue 9 months ago • 7 comments

Proposing a standardized method for assigning and managing NEO Enhancement Proposal (NEP) numbers to address the logistical challenges involved with the naming and referencing of NEP drafts. Currently, NEP drafts cannot be assigned a permanent NEP number until the proposal is officially adopted, causing confusion and inefficiency. This proposal ensures each draft receives a unique and final NEP number upon submission.

Motivation

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 proposal seeks to streamline the process by ensuring each draft receives a unique and final NEP number upon submission.

Specification

  • 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).
  • 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].

Rationale

By standardizing the assignment of NEP numbers at the submission stage, this proposal ensures clarity and consistency in how drafts are referenced and managed throughout their lifecycle. This method reduces ambiguity and simplifies the tracking and updating of proposals, making the NEP process more transparent and accessible.

Backwards Compatibility

This proposal does not introduce technical changes to the NEO protocol but modifies the procedural aspects of the NEP process. It is fully backward compatible as it only affects new submissions.

PR: #172

Jim8y avatar May 22 '24 00:05 Jim8y