forked from bitcoin/bips
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
bip-0002: Clarify and update BIP editor role
- Loading branch information
Showing
1 changed file
with
9 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -83,29 +83,30 @@ The current BIP editor is Luke Dashjr who can be contacted at [[mailto:luke_bipe | |
|
||
===BIP Editor Responsibilities & Workflow=== | ||
|
||
The BIP editor subscribes to the Bitcoin development mailing list. All BIP-related correspondence should be sent (or CC'd) to [email protected]. | ||
The BIP editor subscribes to the Bitcoin development mailing list. | ||
Off-list BIP-related correspondence should be sent (or CC'd) to [email protected]. | ||
|
||
For each new BIP that comes in an editor does the following: | ||
|
||
* Read the BIP to check if it is ready: sound and complete. The ideas must make technical sense, even if they don't seem likely to be accepted. | ||
* The title should accurately describe the content. | ||
* Edit the BIP for language (spelling, grammar, sentence structure, etc.), markup (for reST BIPs), code style (examples should match BIP 8 & 7). | ||
* The BIP draft must have been sent to the Bitcoin development mailing list for discussion. | ||
* Motivation and backward compatibility (when applicable) must be addressed. | ||
* Licensing terms must be acceptable for BIPs. | ||
If the BIP isn't ready, the editor will send it back to the author for revision, with specific instructions. | ||
|
||
Once the BIP is ready for the repository it should be submitted as a "pull request" to the [https://github.com/bitcoin/bips bitcoin/bips] repository on GitHub where it may get further feedback. | ||
Once the BIP is ready for the repository it should be submitted as a "pull request" to the [https://github.com/bitcoin/bips BIPs git repository] where it may get further feedback. | ||
|
||
The BIP editor will: | ||
|
||
* Assign a BIP number (almost always just the next available number, but sometimes it's a special/joke number, like 666 or 3141) in the pull request comments. | ||
* Assign a BIP number in the pull request. | ||
* Merge the pull request when the author is ready (allowing some time for further peer review). | ||
* Merge the pull request when it is ready. | ||
* List the BIP in [[README.mediawiki]] | ||
* Send email back to the BIP author with next steps (post to bitcoin-dev mailing list). | ||
The BIP editors are intended to fulfill administrative and editorial responsibilities. The BIP editors monitor BIP changes, and correct any structure, grammar, spelling, or markup mistakes we see. | ||
The BIP editors are intended to fulfill administrative and editorial responsibilities. The BIP editors monitor BIP changes, and update BIP headers as appropriate. | ||
|
||
==BIP format and structure== | ||
|
||
|