Skip to content

Commit 822b801

Browse files
committed
draft readme
1 parent 6533b16 commit 822b801

File tree

1 file changed

+80
-4
lines changed

1 file changed

+80
-4
lines changed

README.md

Lines changed: 80 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,81 @@
1-
# Bittensor Improvement Proposal (BIP)
1+
# Bittensor Improvement Proposals (BIPs)
22

3-
Bittensor Improvement Proposals provide a standardized process for the Bittensor
4-
community to propose and discuss changes to the protocol. BIPs were inspired by
5-
the Ethereum ecosystem's EIPs
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.
4+
5+
## What is a BIP?
6+
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.
8+
9+
## BIP Types
10+
11+
BIPs are classified into the following categories:
12+
13+
- **Core:** Proposals that impact the core Bittensor protocol and consensus rules.
14+
- **Subtensor:** Proposals that relate to the Subtensor blockchain and related functionality.
15+
- **Networking:** Proposals related to networking protocols, node interactions, or networking infrastructure.
16+
- **Interface:** Proposals related to API, CLI, or user interface improvements.
17+
- **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.
19+
20+
## BIP Lifecycle
21+
22+
Each BIP passes through several stages before it becomes final:
23+
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.
27+
- **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.
29+
- **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).
31+
32+
## How to Submit a BIP
33+
34+
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.
36+
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.
39+
40+
## BIP Numbering
41+
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.
43+
44+
## Roles and Responsibilities
45+
46+
- **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.
49+
50+
## BIP Workflow
51+
52+
The typical workflow for a BIP is as follows:
53+
54+
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.
57+
4. **Final:** The BIP is finalized, merged, and implemented (if applicable).
58+
59+
## FAQs
60+
61+
### 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.
63+
64+
### 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.
66+
67+
### 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.
69+
70+
## Related Links
71+
72+
- [Ethereum Improvement Proposals (EIPs)](https://eips.ethereum.org/)
73+
- [Bitcoin Improvement Proposals (BIPs)](https://github.com/bitcoin/bips)
74+
75+
## License
76+
77+
This repository and all BIPs are licensed under [The Unlicense](LICENSE).
78+
79+
---
80+
81+
This repository is a work in progress, and we welcome your contributions and feedback to improve the BIP process.

0 commit comments

Comments
 (0)