摘要：所提出的改善提案必須是一個(gè)清晰和完整的描述。當(dāng)實(shí)現(xiàn)完成并被社區(qū)采納時(shí)，狀態(tài)將改為結(jié)束。它應(yīng)該清楚地解釋現(xiàn)有的協(xié)議規(guī)范的不足以及解決的問題。沒有充分動(dòng)機(jī)的提案可能被徹底拒絕。

什么是NEP

NEP基本原理

NEP類型

NEP工作流程

怎么才是一個(gè)合格的NEP

NEP格式和模板

NEP序言
附件

NEP所有權(quán)轉(zhuǎn)讓

NEP編輯者

NEP編輯者的職責(zé)和工作流程

歷史

什么是NEP

NEP是NEO改進(jìn)協(xié)議。一份NEP是一份設(shè)計(jì)文檔用于給給NEO社區(qū)提供信息，或是描述一個(gè)NEO的新特性或其工序或環(huán)境。NEP需要對(duì)特性提供一份簡要的技術(shù)說明以及基本原理。NEP的作者有責(zé)任在社區(qū)內(nèi)構(gòu)建輿論和編輯不同的觀點(diǎn)

NEP基本原理

我們計(jì)劃NEP的主要作用是提出新特性，收集社區(qū)中關(guān)于某個(gè)問題的觀點(diǎn)和整理歸納引進(jìn)到NEO中的設(shè)計(jì)決定。由于NEP作為版本文件存儲(chǔ)在版本化的存儲(chǔ)庫中，它們的版本歷史是特性提案的歷史記錄。
對(duì)于NEO的實(shí)施者，NEP是一種便捷的方式來追蹤他們的實(shí)施進(jìn)度。理想情況下，每個(gè)實(shí)施維護(hù)人員都會(huì)列出他們的NEP。如此會(huì)使終端使用者很方便的了解某個(gè)實(shí)現(xiàn)或者庫的狀態(tài)。

NEP類型

有三種類型的NEP：
·一份標(biāo)準(zhǔn)路線 NEP描述任何會(huì)影響多數(shù)NEO實(shí)施者的影響，例如一個(gè)網(wǎng)絡(luò)協(xié)議的改變，一個(gè)區(qū)塊或者交易有效性規(guī)則的改變，擬議應(yīng)用標(biāo)準(zhǔn)/公約，或者任何會(huì)影響應(yīng)用使用NEO操作性的改變或者添加
·一份信息類 NEP描述一個(gè)NEO的設(shè)計(jì)問題，或提供指給社區(qū)指南或者信息，但是并不提議一個(gè)新特性。信息類的NEP并不必然代表一個(gè)NEO社區(qū)的共識(shí)或者推薦，所以使用者或者實(shí)施者可以自由的忽略信息類的NEP或跟隨建議
·一份元NEP描述了一個(gè)圍繞NEO的工序流程，或者提出了一個(gè)工序流程（或事項(xiàng)目）的改變。元NEPS類似于標(biāo)準(zhǔn)路線NEP，但適用于除NEO協(xié)議本身之外的區(qū)域。他們可能提出一個(gè)實(shí)現(xiàn)，但不提到NEO的代碼庫；他們需要社區(qū)的共識(shí)；與信息類NEP不同，它們不僅僅是建議，而且用戶通常不能自由地忽略它們。示例包括流程、指南、決策過程的更改，以及NEO開發(fā)中使用的工具或環(huán)境的更改。

NEP工作流程

一個(gè)NEP的流程開始于一個(gè)關(guān)于NEO的新想法。強(qiáng)烈建議一個(gè)單一的NEP包含一個(gè)單一的關(guān)鍵流程或新想法。多關(guān)注NEP就越容易成功。對(duì)于單一客戶端的變動(dòng)不需要一個(gè)NEP，但可能影響多客戶端的改變或者定義多個(gè)app應(yīng)用標(biāo)準(zhǔn)則需要。NEP編輯者有權(quán)拒絕NEP提案，如果它們顯得過于不集中或過于寬泛。如果有疑問，把你的NEP分成幾個(gè)比較集中的。
每個(gè)NEP必需有個(gè)擁護(hù)者—使用以下描述的風(fēng)格和格式編寫NEP的人，在的論壇中適當(dāng)?shù)闹笇?dǎo)討論，并試圖圍繞這個(gè)想法建立社區(qū)共識(shí)。
在寫一個(gè)NEP前先公開審查一下想法意味著節(jié)約了作者的潛在時(shí)間。先向NEO社區(qū)詢問一個(gè)想法是否具有原創(chuàng)性有助于防止花費(fèi)太多時(shí)間在基于先前討論而保證被否定的事情上（搜索因特網(wǎng)并不總是奏效）。它也有助于確定這個(gè)想法適用于整個(gè)社區(qū)，而不僅僅是作者。僅僅因?yàn)橐粋€(gè)想法對(duì)作者來說聽起來不錯(cuò)，并不意味著它對(duì)使用NEO的各領(lǐng)域的大多數(shù)人都有效。通過合適的論壇來評(píng)估NEP，包括NEO子版、倉庫的問題部分和NEO閑置通道之一。特別的，倉庫的問題部分非常適合與社區(qū)討論你的提議并開始創(chuàng)建一些有有關(guān)于你的NEP的正式言論。

一旦擁護(hù)者向近NEO社區(qū)詢問一個(gè)想法是否有任何機(jī)會(huì)被接納為NEP草案這給了作者一個(gè)連續(xù)編輯NEP草稿的機(jī)會(huì)，用于正確的格式和質(zhì)量。這也允許進(jìn)一步的公眾評(píng)論和NEP的作者來關(guān)注這個(gè)提案。

如果NEP的協(xié)作者同意，NEP編輯者會(huì)給NEP分配一個(gè)數(shù)字，標(biāo)記它是標(biāo)準(zhǔn)、信息、或是元，并給它狀態(tài)‘草案’，并將它加入到git倉庫。NEP編輯者不會(huì)不合理的否定一個(gè)NEP。否定NEP的理由包括重復(fù)勞動(dòng)、技術(shù)不健全、不正當(dāng)動(dòng)機(jī)或向后兼容，或違背NEO的價(jià)值觀

標(biāo)準(zhǔn)追蹤型NEP由三部分組成，設(shè)計(jì)文檔、實(shí)現(xiàn)，最后如果需要更新的正式規(guī)范。在實(shí)施開始之前，NEP需要被審核和采納，除非該實(shí)施將有助于人們研究NEP。標(biāo)準(zhǔn)追蹤型NEP必須包含一個(gè)實(shí)現(xiàn)——以代碼、補(bǔ)丁或URL的形式——在其被認(rèn)定結(jié)束狀態(tài)前。

對(duì)于一個(gè)被接受的NEP，它必須滿足一定的最低標(biāo)準(zhǔn)。所提出的改善提案必須是一個(gè)清晰和完整的描述。改善必須是一個(gè)純的改進(jìn)。提案實(shí)現(xiàn)，如果適用的話，必須是可靠的并且不能過分復(fù)雜化協(xié)議。
一旦NEP被采納，就必須完成實(shí)現(xiàn)。當(dāng)實(shí)現(xiàn)完成并被社區(qū)采納時(shí)，狀態(tài)將改為“結(jié)束”。
NEP也可以被賦予“延期”的狀態(tài)。NEP作者或編輯者可以在NEP沒有進(jìn)展的情況下給NEP分配該狀態(tài)。一旦NEP被推遲，NEP編輯者可以重新將其分配成草稿狀態(tài)。

NEP也可以被“拒絕”。也許這不是個(gè)好主意。記錄這一事實(shí)仍然很重要。

NEP也可以被一個(gè)不同的NEP替代，使原來的過期。

NEP狀況的可能路徑如下：

一些信息型或元NEP也可能是狀態(tài)“活躍”如果他們從未被完成，例如NEP1（本NEP）。

怎么才是一個(gè)合格的NEP

每個(gè)NEP應(yīng)該有以下部分：
·序言——RFC 822樣式標(biāo)頭，包含關(guān)于NEP的元數(shù)據(jù)，包括NEP編號(hào)、簡短的描述性標(biāo)題（限制最多44個(gè)字符）、姓名、以及可選的每個(gè)作者的聯(lián)系人信息等。
·摘要——-一個(gè)簡短的（200字）描述正在處理的技術(shù)問題。
·動(dòng)機(jī)（*可選）-動(dòng)機(jī)是那些想要改變NEO協(xié)議的NEP至關(guān)重要的部分。它應(yīng)該清楚地解釋現(xiàn)有的協(xié)議規(guī)范的不足以及NEP解決的問題。沒有充分動(dòng)機(jī)的NEP提案可能被徹底拒絕。
·詳述——技術(shù)詳述應(yīng)該描述新特征的語法和語義。該規(guī)范應(yīng)該足夠詳細(xì)，以允許針對(duì)任何當(dāng)前NEO平臺(tái)的競爭、可互操作的實(shí)現(xiàn)。

?基本原理——基本原理詳細(xì)說明設(shè)計(jì)目的以及設(shè)計(jì)方案的理由。它應(yīng)該描述相關(guān)工作的替代設(shè)計(jì)，例如在其他語言中如何支持該特性?；驹硪部梢蕴峁┥鐓^(qū)內(nèi)共同意見的證據(jù)，并且應(yīng)當(dāng)討論在討論期間提出的重要反對(duì)或重點(diǎn)。

·向后兼容性——引入向后兼容性的所有NEP必須包括描述其不兼容性及其嚴(yán)重性。NEP必須解釋作者是如何處理這些不兼容性的。沒有足夠的向后兼容性的NEP提交可能被徹底拒絕。

·測試用例——實(shí)現(xiàn)的測試用例對(duì)于那些會(huì)引起共識(shí)改變的NEP是必須的。其他NEP可以選擇包括測試用例的鏈接如果需要的化。

·實(shí)現(xiàn)——實(shí)現(xiàn)必須在任何NEP“完結(jié)”狀態(tài)前之前完成，但是不需要在NEP受理前完成。最好先完成規(guī)范和原理并在編寫代碼之前達(dá)成共識(shí)。

NEP格式和模板

NEP必需用 mediawiki or markdown格式編寫。圖片文件必需包含在NEP的子目錄。

NEP序言

每個(gè)ＮＥＰ必須由一個(gè)RFC822格式的頭部欄開始。頭部欄必須包含以下順序。
用*號(hào)標(biāo)示的是可選的，稍后寫介紹。其他都是必須的。
NEP: (由NEP編輯者決定)
Title:
Author:
*Discussions-To:
Status: Final | Superseded>
Type:
Created:
*Replaces:
*Superseded-By:
*Resolution:

作者頭部欄列出NEP的所有作者/所有者的姓名，以及可選的電子郵件地址。作者頭值的格式必須是 Random J. User [email protected]有email地址的情況下，Random J. User 沒有email地址的情況下。
如果有多個(gè)作者，每一個(gè)都應(yīng)在之后獨(dú)立的一行中的遵守RFC2822的協(xié)議。

注意：解決方案欄只適用于標(biāo)準(zhǔn)追蹤型NEP。它包含一個(gè)URL，該URL應(yīng)該指向一個(gè)電子郵件消息或其他關(guān)于NEP的聲明的Web資源。
當(dāng)NEP處于私下討論階段時(shí)（通常在初始草稿階段），Discussions-To欄將指示正在討論NEP的郵件列表或URL。如果NEP處于與作者私下討論階段，則不需Discussions-To欄。
類型欄指定NEP的類型：標(biāo)準(zhǔn)、信息或元。
創(chuàng)建欄記錄了NEP被分配編號(hào)的日期。它應(yīng)該是YYYY-MM-DD格式，例如2001-08-14。
NEPS可能有一個(gè)需求欄，指示NEP依賴的NEP編號(hào)。
NEP還可以有一個(gè)Superseded-By欄，指示NEP已經(jīng)被后面的文檔淘汰；該值是替換當(dāng)前文檔的NEP文檔編號(hào)。較新的NEP必須有一個(gè)替換欄，該欄包含其過時(shí)的NEP編號(hào)。

附件

NEP可以包括附件，如圖表。此類文件必須包含在該NEP的子目錄中，并命名為nep-x-y.ext，其中“x”是NEP編號(hào)，“y”是序列號(hào)（從1開始），而“ext”被實(shí)際的文件擴(kuò)展名（例如“png”）替換。

NEP所有權(quán)轉(zhuǎn)讓

有時(shí)候需要將NEP所有權(quán)轉(zhuǎn)讓給新的擁護(hù)者。一般來說，我們希望保留原作者作為已轉(zhuǎn)移NEP的合著者，但這取決于原作者。轉(zhuǎn)移所有權(quán)的一個(gè)恰當(dāng)?shù)睦碛墒?，因?yàn)樵甲髡卟辉儆袝r(shí)間或興趣更新它，或者繼續(xù)執(zhí)行NEP的流程，或者已經(jīng)脫離“網(wǎng)絡(luò)”的位面（即，無法訪問或不回復(fù)電子郵件）。轉(zhuǎn)移所有權(quán)的一個(gè)不恰當(dāng)?shù)脑蚴且驗(yàn)槟悴煌釴EP的方向。我們?cè)噲D在圍繞NEP建立共識(shí)，但如果這是不可能的，你可以提交一個(gè)競爭的NEP。

如果您有興趣接管NEP的所有權(quán)，請(qǐng)向原始作者和NEP編輯者發(fā)送請(qǐng)求接管的消息。如果原作者沒有及時(shí)回復(fù)郵件，NEP編輯者會(huì)做出單方面的決定（此類決定并非不能逆轉(zhuǎn):）.

NEP編輯者

當(dāng)前的NEP編輯者是
·Erik Zhang (@erikzhang)

NEP編輯者的職責(zé)和工作流程

每收到一份新的NEP，編輯者會(huì)做如下事情：
·閱讀NEP檢查它是否完備：健全和完整。想法必需有技術(shù)意義，即使它看起來并不能被接受。
·標(biāo)題必需準(zhǔn)確的描述內(nèi)容。
·編輯NEP的語言（拼寫，語法，句子結(jié)構(gòu)等），標(biāo)記，代碼風(fēng)格。

如果NEP并不完備，編輯者會(huì)將其退回給作者重新修訂，并給出具體說明
一旦NEP準(zhǔn)備好合到倉庫,NEP編輯者會(huì):
·分配一個(gè)NEP編號(hào)(基本是下一個(gè)可用的數(shù)字,但有時(shí)也可能是一個(gè)特殊數(shù)字,例如666或者3141)在拉取請(qǐng)求的評(píng)論中.
·當(dāng)作者準(zhǔn)備好后合并下拉請(qǐng)求(允許有進(jìn)一步的同行評(píng)審時(shí)間).
·在README.mediawiki中列出NEP.
·回復(fù)NEP作者告知下一步操作.
NEP編輯者旨在履行管理和編輯的職責(zé).NEP編輯者收集NEP的變化,并改正任何我們看到的結(jié)構(gòu)、語法、拼寫或標(biāo)記上的額錯(cuò)誤。

歷史

本文檔是根據(jù)Amir Taaki從Python版PEP-0001衍生出的比特幣的BIP-0001文檔編寫的。在許多地方僅是簡單復(fù)制和修改。雖然PEP-0001文檔是由Barry Warsaw, Jeremy Hylton, and David Goodger編寫，但是他們并不負(fù)責(zé)其在NEO改善過程中的使用，并且不用回答任何NEO或者NEP的技術(shù)問題。請(qǐng)把所有意見評(píng)論直接提交給NEP編輯者。

原文：來自 https://github.com/neo-projec...