Skip to content

Commit 16f0249

Browse files
committed
word wrap
1 parent 822b801 commit 16f0249

File tree

1 file changed

+49
-21
lines changed

1 file changed

+49
-21
lines changed

README.md

Lines changed: 49 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,98 @@
11
# Bittensor Improvement Proposals (BIPs)
22

3-
Welcome to the Bittensor Improvement Proposals (BIPs) repository. This repository serves as the central location for submitting, discussing, and tracking proposals for changes and improvements to the Bittensor protocol.
3+
Welcome to the Bittensor Improvement Proposals (BIPs) repository. This repository serves as the
4+
central location for submitting, discussing, and tracking proposals for changes and
5+
improvements to the Bittensor protocol.
46

57
## What is a BIP?
68

7-
A Bittensor Improvement Proposal (BIP) is a design document providing information to the Bittensor community or describing a new feature for Bittensor, its processes, or its environment. The BIP should provide a concise technical specification of the feature and a rationale for the feature. BIPs are intended to be the primary mechanism for proposing new features, collecting community input on an issue, and documenting the design decisions that have gone into Bittensor.
9+
A Bittensor Improvement Proposal (BIP) is a design document providing information to the
10+
Bittensor community or describing a new feature for Bittensor, its processes, or its
11+
environment. The BIP should provide a concise technical specification of the feature and a
12+
rationale for the feature. BIPs are intended to be the primary mechanism for proposing new
13+
features, collecting community input on an issue, and documenting the design decisions that
14+
have gone into Bittensor.
815

916
## BIP Types
1017

1118
BIPs are classified into the following categories:
1219

1320
- **Core:** Proposals that impact the core Bittensor protocol and consensus rules.
1421
- **Subtensor:** Proposals that relate to the Subtensor blockchain and related functionality.
15-
- **Networking:** Proposals related to networking protocols, node interactions, or networking infrastructure.
22+
- **Networking:** Proposals related to networking protocols, node interactions, or networking
23+
infrastructure.
1624
- **Interface:** Proposals related to API, CLI, or user interface improvements.
1725
- **Meta:** Proposals about processes or changes to the BIP system itself.
18-
- **Informational:** Proposals that provide general guidelines or information to the Bittensor community but do not propose a new feature.
26+
- **Informational:** Proposals that provide general guidelines or information to the Bittensor
27+
community but do not propose a new feature.
1928

2029
## BIP Lifecycle
2130

2231
Each BIP passes through several stages before it becomes final:
2332

24-
- **Draft:** The initial state of a BIP when submitted as a pull request. In this stage, the BIP is open for discussion and feedback.
25-
- **Review:** The BIP has passed the initial review and is now under formal review by the BIP editors and the community.
26-
- **Last Call:** The BIP is nearing finalization and has a set period for final comments and objections.
33+
- **Draft:** The initial state of a BIP when submitted as a pull request. In this stage, the
34+
BIP is open for discussion and feedback.
35+
- **Review:** The BIP has passed the initial review and is now under formal review by the BIP
36+
editors and the community.
37+
- **Last Call:** The BIP is nearing finalization and has a set period for final comments and
38+
objections.
2739
- **Final:** The BIP is considered complete and implemented (or ready for implementation).
28-
- **Stagnant:** The BIP has not been updated for a significant period or lacks consensus, so it is no longer considered active.
40+
- **Stagnant:** The BIP has not been updated for a significant period or lacks consensus, so it
41+
is no longer considered active.
2942
- **Withdrawn:** The author of the BIP has decided to withdraw the proposal.
30-
- **Living:** The BIP is a living document that is continually updated with new information (e.g., coding standards or best practices).
43+
- **Living:** The BIP is a living document that is continually updated with new information
44+
(e.g., coding standards or best practices).
3145

3246
## How to Submit a BIP
3347

3448
1. **Fork this repository.**
35-
2. **Create a new file** in the `BIPs/` directory named `BIP-XXXX.md`, where `XXXX` is the next available BIP number. You can use the [BIP template](BIP-0000-template.md) as a starting point.
49+
2. **Create a new file** in the `BIPs/` directory named `BIP-XXXX.md`, where `XXXX` is the next
50+
available BIP number. You can use the [BIP template](BIP-0000-template.md) as a starting
51+
point.
3652
3. **Fill in the template** with your proposal details.
37-
4. **Submit a pull request** with your new BIP. The title should be "BIP-XXXX: [Title]" where `XXXX` is your BIP number.
38-
5. **Engage in the discussion**: Address any feedback from the community and BIP editors during the review process.
53+
4. **Submit a pull request** with your new BIP. The title should be "BIP-XXXX: [Title]" where
54+
`XXXX` is your BIP number.
55+
5. **Engage in the discussion**: Address any feedback from the community and BIP editors during
56+
the review process.
3957

4058
## BIP Numbering
4159

42-
BIPs are assigned numbers in the order they are proposed. The number `0000` is reserved for the BIP template. Once a BIP is accepted and merged, its number is locked and cannot be changed.
60+
BIPs are assigned numbers in the order they are proposed. The number `0000` is reserved for the
61+
BIP template. Once a BIP is accepted and merged, its number is locked and cannot be changed.
4362

4463
## Roles and Responsibilities
4564

4665
- **Author:** The person who wrote and is responsible for the BIP.
47-
- **Editor:** A member of the community who is responsible for ensuring that BIPs are clear, concise, and meet the repository's standards. Editors do not make decisions about BIP approval but facilitate the process.
48-
- **Reviewer:** Any community member who reviews and provides feedback on BIPs during the Draft and Review stages.
66+
- **Editor:** A member of the community who is responsible for ensuring that BIPs are clear,
67+
concise, and meet the repository's standards. Editors do not make decisions about BIP
68+
approval but facilitate the process.
69+
- **Reviewer:** Any community member who reviews and provides feedback on BIPs during the Draft
70+
and Review stages.
4971

5072
## BIP Workflow
5173

5274
The typical workflow for a BIP is as follows:
5375

5476
1. **Draft:** The BIP is submitted as a pull request and is open for discussion.
55-
2. **Review:** After initial discussion, the BIP moves to the Review stage, where it undergoes more rigorous analysis.
56-
3. **Last Call:** If the BIP passes the Review stage, it enters the Last Call phase for any final comments.
77+
2. **Review:** After initial discussion, the BIP moves to the Review stage, where it undergoes
78+
more rigorous analysis.
79+
3. **Last Call:** If the BIP passes the Review stage, it enters the Last Call phase for any
80+
final comments.
5781
4. **Final:** The BIP is finalized, merged, and implemented (if applicable).
5882

5983
## FAQs
6084

6185
### What is the purpose of a BIP?
62-
BIPs serve as the primary mechanism for proposing new features or changes to the Bittensor protocol, fostering open-source development, transparency, and structured decision-making.
86+
BIPs serve as the primary mechanism for proposing new features or changes to the Bittensor
87+
protocol, fostering open-source development, transparency, and structured decision-making.
6388

6489
### How are BIPs approved?
65-
BIPs are approved through community consensus during the Review and Last Call stages. Editors facilitate the process but do not unilaterally approve BIPs.
90+
BIPs are approved through community consensus during the Review and Last Call stages. Editors
91+
facilitate the process but do not unilaterally approve BIPs.
6692

6793
### Can I update a BIP after it is finalized?
68-
Once a BIP is finalized, it is generally considered complete. However, living BIPs are an exception and can be updated regularly.
94+
Once a BIP is finalized, it is generally considered complete. However, living BIPs are an
95+
exception and can be updated regularly.
6996

7097
## Related Links
7198

@@ -78,4 +105,5 @@ This repository and all BIPs are licensed under [The Unlicense](LICENSE).
78105

79106
---
80107

81-
This repository is a work in progress, and we welcome your contributions and feedback to improve the BIP process.
108+
This repository is a work in progress, and we welcome your contributions and feedback to
109+
improve the BIP process.

0 commit comments

Comments
 (0)