Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the BIP Process #2

Open
wants to merge 116 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 103 commits
Commits
Show all changes
116 commits
Select commit Hold shift + click to select a range
bbf7c51
Create first outline
murchandamus May 13, 2024
d1d49e9
Add an initial abstract
murchandamus May 13, 2024
0bd8036
Start filling in Workflow
murchandamus May 15, 2024
4643b16
Use "champion" for BIP Author
murchandamus May 28, 2024
74e691d
Revisit Abstract and What is a BIP?
murchandamus Jun 14, 2024
e600c49
Deliberate significance of BIPs
murchandamus Jun 14, 2024
3f990ed
Rework draft stage of BIP workflow, add BIP-0002 to bottom of document
murchandamus Jun 14, 2024
97744be
Require proof of work before number assignment
murchandamus Jun 17, 2024
9426c2e
Describe Proposed and Withdrawn
murchandamus Jun 17, 2024
613f1ff
Clarify Proposed, describe Withdrawn, and retain Transferring Ownership
murchandamus Jun 17, 2024
59c9f12
Retain description of BIP Types
murchandamus Jun 17, 2024
0214659
Minor improvements to process description
murchandamus Jun 17, 2024
4ba4e47
Describe optional FINAL/ACTIVE status
murchandamus Jun 17, 2024
f076ade
Start tracking changes compared to BIP 2
murchandamus Jun 17, 2024
ba40daa
Drop "changes to environment and tools" from process examples
murchandamus Jun 20, 2024
affea61
State that adoption tracking is out of scope
murchandamus Jun 20, 2024
f23cf9d
Inherit initial BIP Editors section from BIP-2
murchandamus Jun 20, 2024
556e2d4
Move BIP Types to top, reiterate adoption
murchandamus Jun 20, 2024
598848b
Update responsibilities of BIP editors
murchandamus Jun 20, 2024
96df5fe
Define scope of the BIPs repository
murchandamus Jun 20, 2024
ca32adb
Add image for Status transitions
murchandamus Jun 20, 2024
5017847
Add second variant for transition diagram
murchandamus Jun 20, 2024
ddfe787
Add Revisions as an optional topic
murchandamus Jun 21, 2024
88e68c0
Note that Proposed overloads with Proposal
murchandamus Jun 21, 2024
2ffcb8d
Track open issues
murchandamus Jun 21, 2024
851858c
Inherit formatting spec from BIP-2 as a start
murchandamus Jun 21, 2024
10e23f5
Reword BIP section descriptions
murchandamus Jun 21, 2024
7ce39f9
Reword preamble instructions
murchandamus Jun 21, 2024
896b4ec
Rename Author header to Champions header
murchandamus Jun 21, 2024
3916387
Test whether footnotes via ref work
murchandamus Jun 21, 2024
5d50bb1
Update preamble header descriptions
murchandamus Jun 21, 2024
2d2d4f1
Drop Discussions-To header
murchandamus Jun 21, 2024
0296846
Drop Comments, Comments-URI, and Comments-Summary
murchandamus Jun 21, 2024
13b64e3
Swap order of Specification and Workflow
murchandamus Jun 21, 2024
4a4b640
Mark Open questions as todo
murchandamus Jun 21, 2024
33ed167
BIPs do not become rejected due to inactivity
murchandamus Jun 24, 2024
02c9717
Move changes to the bottom for easier access
murchandamus Jun 24, 2024
afb5b9c
Update Licensing instructions
murchandamus Jun 24, 2024
56ebea0
Add open question about change log
murchandamus Jun 24, 2024
0446c5f
Mention inacceptability of OPL in rationale
murchandamus Jun 24, 2024
7727100
Discourage 'Other Implementations' sections
murchandamus Jun 24, 2024
3ae7a3b
Combine Status Field description and workflow (WIP)
murchandamus Jun 26, 2024
5b0f797
Incorporate Status Field section into Workflow
murchandamus Jul 2, 2024
8168178
Match transition graph to status field values
murchandamus Jul 3, 2024
c30ec6a
Rename Proposed to Nominated
murchandamus Jul 3, 2024
b67dda6
Expand acceptable changes of Nominated BIP
murchandamus Jul 3, 2024
e90f180
Pascal-case the Status field values
murchandamus Jul 3, 2024
a677b0d
Collect Rationale in one section
murchandamus Jul 3, 2024
b09ca95
Remove outdated graphics
murchandamus Jul 3, 2024
7d2b81a
Fix minor optical issues and broken links
murchandamus Jul 3, 2024
a6b5e65
Clarify that feedback must be actionable
murchandamus Jul 3, 2024
7f90aa5
Update Changes to BIP 2 section
murchandamus Jul 3, 2024
99646f1
Add linebreaks to footnotes
murchandamus Jul 3, 2024
f2b1a6c
Add link to incident report example
murchandamus Jul 5, 2024
6ad4172
Update Preamble description
murchandamus Jul 5, 2024
a676839
Describe Change Log section
murchandamus Jul 5, 2024
d6780d7
Address minor issues from review
murchandamus Jul 5, 2024
4b63d36
Update terminology for status update
murchandamus Jul 5, 2024
374ab86
Return BSD licenses to acceptable
murchandamus Jul 9, 2024
8194030
Use Author instead of Champion
murchandamus Jul 9, 2024
d198deb
Replace Nominated with Preliminary
murchandamus Jul 9, 2024
e4b4c7c
Replace Post-History header with Discussion
murchandamus Jul 9, 2024
e4a59ab
Small improvements
murchandamus Jul 9, 2024
d3d0e7e
Harmonize references to other BIPs
murchandamus Jul 9, 2024
d5a3e91
Strike open points
murchandamus Jul 9, 2024
564c38d
Match short and long description of Created Header
murchandamus Jul 9, 2024
df1e84a
Improve description of interactions with Abandoned
murchandamus Jul 10, 2024
57d8c08
Update Comparison to BIP 2
murchandamus Jul 10, 2024
f5e5414
Add Backwards Compatibility section
murchandamus Jul 10, 2024
41cd06a
Make Process BIPs living documents
murchandamus Jul 10, 2024
dea58f3
Elaborate on scope of repository (H/T RFC 2223)
murchandamus Jul 11, 2024
452c05c
Replace Standards Track with Specification type
murchandamus Jul 11, 2024
b35e02f
Minor update to Significance of BIPs
murchandamus Jul 11, 2024
ac95ca2
Improve Abstract
murchandamus Jul 16, 2024
0caa8aa
Addressing feedback WIP
murchandamus Jul 19, 2024
6b184dc
Address several small feedback items
murchandamus Jul 19, 2024
eea8df8
Drop astroturfing footnote
murchandamus Aug 30, 2024
f667bf0
Add Motivation
murchandamus Sep 13, 2024
8458dfd
Add footnote recommending to stick to basic Markdown features
murchandamus Sep 13, 2024
9e804df
Require only Preamble, Abstract, and Copyright
murchandamus Sep 13, 2024
e07f38e
Drop footnotes
murchandamus Sep 13, 2024
94cebfd
Amend Preamble, raise title limit to 50 characters
murchandamus Sep 13, 2024
fd423a8
Rewrite the Discussion header description
murchandamus Sep 13, 2024
3504b74
Amend scope 'aim to support'
murchandamus Sep 16, 2024
4ba4899
Update description of License identifiers
murchandamus Sep 16, 2024
1da9d40
Update README to match updated process
murchandamus Sep 16, 2024
3c47a01
Touch up Status and Ownership
murchandamus Sep 16, 2024
85c4fe5
Update Changes to BIP 2
murchandamus Sep 16, 2024
e987582
Use BSD-2-Clause to adhere to license of BIP 2
murchandamus Sep 16, 2024
1a648aa
Add Rationale for new BIPs over new versions
murchandamus Sep 16, 2024
36e716f
Add examples for out-of-scope topics
murchandamus Sep 16, 2024
27e174c
Fix typos and minor details from readthrough
murchandamus Sep 16, 2024
a4c8b23
Invert recommendation to split proposals
murchandamus Sep 17, 2024
b10f117
Reword incomplete specification
murchandamus Sep 17, 2024
c41b2ee
Warn against breaking changes in implemented BIPs
murchandamus Sep 17, 2024
311b3d0
Require settled BIP before Active
murchandamus Sep 17, 2024
e158b95
Strengthen recommendation for discussion on ML
murchandamus Sep 17, 2024
201ffd2
Use absolute link to BIP 352
murchandamus Sep 17, 2024
c1e27bb
Add Revision header to Preamble
murchandamus Sep 17, 2024
b795d91
Fix Discussion example link
murchandamus Sep 17, 2024
2cb5a90
Recast status field values
murchandamus Sep 18, 2024
2f1cd93
Address Larry’s feedback in README
murchandamus Sep 18, 2024
e2378f3
Adopt small improvements from Review
murchandamus Sep 18, 2024
d226be7
Avoid the term draft
murchandamus Sep 20, 2024
f2c1afb
Revert to Draft for the first state
murchandamus Sep 20, 2024
52304cd
Revert "Ready" to "Proposed"
murchandamus Sep 20, 2024
78b6b44
Reconsider uses of words that matched statuses
murchandamus Sep 20, 2024
cf2e14f
Defer changes to README until Proposal is adopted
murchandamus Sep 20, 2024
81a2310
Address minor review concerns
murchandamus Sep 20, 2024
b54223d
Capitalize bitcoin only in proper nouns
murchandamus Sep 20, 2024
7650ff3
Address Larry’s feedback comments
murchandamus Sep 20, 2024
4f99f38
Update status diagram to match Statuses
murchandamus Sep 20, 2024
3bdc703
Adopt remaining comments from Larry’s review
murchandamus Sep 20, 2024
5113902
Improve Process BIP description
murchandamus Sep 20, 2024
7a359f7
Drop phrase about off-list correspondence
murchandamus Sep 20, 2024
985f976
Adopt suggestion to Scope section
murchandamus Sep 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions README.mediawiki
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
People wishing to submit BIPs, first should propose their idea or document to the [https://groups.google.com/g/bitcoindev bitcoindev@googlegroups.com] mailing list (do <em>not</em> assign a number - read <a href="bip-0002.mediawiki">BIP 2</a> for the full process). After discussion, please open a PR. After copy-editing and acceptance, it will be published here.
People wishing to submit BIPs should first describe their idea to the [https://groups.google.com/g/bitcoindev
bitcoindev@googlegroups.com] mailing list. Please open a pull request to this repository only when substantial progress
on the draft has been made, preferably when the draft is nearing completion. After a proposal meets the editorial
criteria, a BIP Editor will assign a number to it, and publish the proposal by merging the pull request to the
repository. Authors do <em>not</em> assign a number to their own proposal. Please see <a
href="bip-update-process.md">tk: BIP Update Process</a> for the full process.

We are fairly liberal with approving BIPs, and try not to be too involved in decision making on behalf of the community. The exception is in very rare cases of dispute resolution when a decision is contentious and cannot be agreed upon. In those cases, the conservative option will always be preferred.

Having a BIP here does not make it a formally accepted standard until its status becomes Final or Active.

Those proposing changes should consider that ultimately consent may rest with the consensus of the Bitcoin users (see also: [https://en.bitcoin.it/wiki/Economic_majority economic majority]).
The BIPs repository serves as a publication medium and archive. Having a BIP published here indicates that the proposal
is in scope and has met other formal criteria for this repository, but does not indicate that it is a good idea, has
community consensus, or that it is about to be adopted. The BIP Editors are expected to be liberal with approving BIPs
and try not to be too involved in decision-making on behalf of the community. Beyond the formal criteria, evaluation of
the proposals is left to the audience of the repository. The exceptions are rare cases when a decision is contentious
and cannot be agreed upon. In those cases, the conservative option will be preferred. Authors proposing changes should
Copy link

@jonatack jonatack Sep 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps drop "and cannot be agreed upon" and instead something like

"The exceptions are when a proposal is contentious or appears controversial, in which case BIP editors may prefer to opt for prudence or the more conservative path."

Copy link
Owner Author

@murchandamus murchandamus Sep 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that this improves the phrasing, but it also leaves the outcome completely open. I would prefer if the guidance established some sort of expectation toward an outcome.

Thinking more about it, the appropriate time to adapt the README to match this proposal would probably be when this proposal is adopted by the community, rather when it is merged to the repository, so I am deferring the changes to the README to that time and have separated them into another PR #3.

consider that ultimately, consent rests with the Bitcoin users (see also: [https://en.bitcoin.it/wiki/Economic_majority
economic majority]).

{| class="wikitable sortable" style="width: auto; text-align: center; font-size: smaller; table-layout: fixed;"
!Number
Expand Down
Loading