|
1 |
| -# Bittensor Improvement Proposals (BIPs) |
| 1 | +# Bittensor Improvement Templates (BITs) |
2 | 2 |
|
3 |
| -Welcome to the Bittensor Improvement Proposals (BIPs) |
4 |
| -[repository](https://github.com/opentensor/bips). This repository serves as the central |
| 3 | +Welcome to the Bittensor Improvement Templates (BITs) |
| 4 | +[repository](https://github.com/opentensor/bits). This repository serves as the central |
5 | 5 | location for submitting, discussing, and tracking proposals for changes and improvements to the
|
6 | 6 | Bittensor protocol.
|
7 | 7 |
|
8 |
| -## What is a BIP? |
| 8 | +## What are BITs? |
9 | 9 |
|
10 |
| -A Bittensor Improvement Proposal (BIP) is a technical design document providing information to |
| 10 | +A Bittensor Improvement Template (BIT) is a technical design document providing information to |
11 | 11 | the Bittensor community or describing new features for the Bittensor protocol and surrounding
|
12 |
| -ecosystem. A BIP should provide a convincing rationale for and a concise technical |
13 |
| -specification of any underlying features described in the BIP. BIPs are intended to be the |
| 12 | +ecosystem. A BIT should provide a convincing rationale for and a concise technical |
| 13 | +specification of any underlying features described in the BIT. BITs are intended to be the |
14 | 14 | primary mechanism for proposing new features and changes, collecting community input on an
|
15 | 15 | issue, and documenting design decisions that impact the protocol.
|
16 | 16 |
|
17 |
| -## BIP Types |
| 17 | +## Types of BITs |
18 | 18 |
|
19 |
| -BIPs are classified into the following categories: |
| 19 | +BITs are classified into the following categories: |
20 | 20 |
|
21 | 21 | - **Core:** Proposals that impact the core Bittensor protocol and consensus rules.
|
22 | 22 | - **Subtensor:** Proposals that relate to the Subtensor blockchain and related functionality.
|
23 | 23 | - **Networking:** Proposals related to networking protocols, node interactions, or networking
|
24 | 24 | infrastructure.
|
25 | 25 | - **Interface:** Proposals related to API, CLI, or user interface improvements.
|
26 |
| -- **Meta:** Proposals about processes or changes to the BIP system itself. |
| 26 | +- **Meta:** Proposals about processes or changes to the BIT system itself. |
27 | 27 | - **Informational:** Proposals that provide general guidelines or information to the Bittensor
|
28 | 28 | community but do not propose a new feature.
|
29 | 29 |
|
30 |
| -## BIP Lifecycle |
| 30 | +## BITs Lifecycle |
31 | 31 |
|
32 |
| -Each BIP passes through several stages before it becomes final: |
| 32 | +BITs pass through several stages before it becomes final: |
33 | 33 |
|
34 |
| -- **Draft:** The initial state of a BIP when submitted as a pull request. In this stage, the |
35 |
| - BIP is open for discussion and feedback. |
36 |
| -- **Review:** The BIP has passed the initial review and is now under formal review by the BIP |
| 34 | +- **Draft:** The initial state of a BIT when submitted as a pull request. In this stage, the |
| 35 | + BIT is open for discussion and feedback. |
| 36 | +- **Review:** The BIT has passed the initial review and is now under formal review by the BIT |
37 | 37 | editors and the community.
|
38 |
| -- **Last Call:** The BIP is nearing finalization and has a set period for final comments and |
| 38 | +- **Last Call:** The BIT is nearing finalization and has a set period for final comments and |
39 | 39 | objections.
|
40 |
| -- **Final:** The BIP is considered complete and implemented (or ready for implementation). |
41 |
| -- **Stagnant:** The BIP has not been updated for a significant period or lacks consensus, so it |
| 40 | +- **Final:** The BIT is considered complete and implemented (or ready for implementation). |
| 41 | +- **Stagnant:** The BIT has not been updated for a significant period or lacks consensus, so it |
42 | 42 | is no longer considered active.
|
43 |
| -- **Withdrawn:** The author of the BIP has decided to withdraw the proposal. |
44 |
| -- **Living:** The BIP is a living document that is continually updated with new information |
| 43 | +- **Withdrawn:** The author of the BIT has decided to withdraw the proposal. |
| 44 | +- **Living:** The BIT is a living document that is continually updated with new information |
45 | 45 | (e.g., coding standards or best practices).
|
46 | 46 |
|
47 |
| -## How to Submit a BIP |
| 47 | +## How to Submit BITs |
48 | 48 |
|
49 | 49 | 1. **Fork this repository.**
|
50 |
| -2. **Create a new file** in the `BIPs/` directory named `BIP-XXXX.md`, where `XXXX` is the next |
51 |
| - available BIP number. You can use the [BIP template](BIP-0000-template.md) as a starting |
| 50 | +2. **Create a new file** in the `BITs/` directory named `BIT-XXXX.md`, where `XXXX` is the next |
| 51 | + available BIT number. You can use the [BIT template](BIT-0000-template.md) as a starting |
52 | 52 | point.
|
53 | 53 | 3. **Fill in the template** with your proposal details.
|
54 |
| -4. **Submit a pull request** with your new BIP. The title should be "BIP-XXXX: [Title]" where |
55 |
| - `XXXX` is your BIP number. |
56 |
| -5. **Engage in the discussion**: Address any feedback from the community and BIP editors during |
| 54 | +4. **Submit a pull request** with your new BIT. The title should be "BIT-XXXX: [Title]" where |
| 55 | + `XXXX` is your BIT number. |
| 56 | +5. **Engage in the discussion**: Address any feedback from the community and BIT editors during |
57 | 57 | the review process.
|
58 | 58 |
|
59 |
| -## BIP Numbering |
| 59 | +## BITs Numbering |
60 | 60 |
|
61 |
| -BIPs are assigned numbers in the order they are proposed. The number `0000` is reserved for the |
62 |
| -BIP template. Once a BIP is accepted and merged, its number is locked and cannot be changed. |
| 61 | +BITs are assigned numbers in the order they are proposed. The number `0000` is reserved for the |
| 62 | +BIT template. Once a BIT is accepted and merged, its number is locked and cannot be changed. |
63 | 63 |
|
64 | 64 | ## Roles and Responsibilities
|
65 | 65 |
|
66 |
| -- **Author:** The person who wrote and is responsible for the BIP. |
67 |
| -- **Editor:** A member of the community who is responsible for ensuring that BIPs are clear, |
68 |
| - concise, and meet the repository's standards. Editors do not make decisions about BIP |
| 66 | +- **Author:** The person who wrote and is responsible for the BIT. |
| 67 | +- **Editor:** A member of the community who is responsible for ensuring that BITs are clear, |
| 68 | + concise, and meet the repository's standards. Editors do not make decisions about BIT |
69 | 69 | approval but facilitate the process.
|
70 |
| -- **Reviewer:** Any community member who reviews and provides feedback on BIPs during the Draft |
| 70 | +- **Reviewer:** Any community member who reviews and provides feedback on BITs during the Draft |
71 | 71 | and Review stages.
|
72 | 72 |
|
73 |
| -## BIP Workflow |
| 73 | +## BITs Workflow |
74 | 74 |
|
75 |
| -The typical workflow for a BIP is as follows: |
| 75 | +The typical workflow for a BIT is as follows: |
76 | 76 |
|
77 |
| -1. **Draft:** The BIP is submitted as a pull request and is open for discussion. |
78 |
| -2. **Review:** After initial discussion, the BIP moves to the Review stage, where it undergoes |
| 77 | +1. **Draft:** The BIT is submitted as a pull request and is open for discussion. |
| 78 | +2. **Review:** After initial discussion, the BIT moves to the Review stage, where it undergoes |
79 | 79 | more rigorous analysis.
|
80 |
| -3. **Last Call:** If the BIP passes the Review stage, it enters the Last Call phase for any |
| 80 | +3. **Last Call:** If the BIT passes the Review stage, it enters the Last Call phase for any |
81 | 81 | final comments.
|
82 |
| -4. **Final:** The BIP is finalized, merged, and implemented (if applicable). |
| 82 | +4. **Final:** The BIT is finalized, merged, and implemented (if applicable). |
83 | 83 |
|
84 | 84 | ## FAQs
|
85 | 85 |
|
86 |
| -### What is the purpose of a BIP? |
87 |
| -BIPs serve as the primary mechanism for proposing new features or changes to the Bittensor |
| 86 | +### What is the purpose of BITs? |
| 87 | +BITs serve as the primary mechanism for proposing new features or changes to the Bittensor |
88 | 88 | protocol, fostering open-source development, transparency, and structured decision-making.
|
89 | 89 |
|
90 |
| -### How are BIPs approved? |
91 |
| -BIPs are approved through community consensus during the Review and Last Call stages. Editors |
92 |
| -facilitate the process but do not unilaterally approve BIPs. |
| 90 | +### How are BITs approved? |
| 91 | +BITs are approved through community consensus during the Review and Last Call stages. Editors |
| 92 | +facilitate the process but do not unilaterally approve BITs. |
93 | 93 |
|
94 |
| -### Can I update a BIP after it is finalized? |
95 |
| -Once a BIP is finalized, it is generally considered complete. However, living BIPs are an |
| 94 | +### Can I update BITs after they are finalized? |
| 95 | +Once BITs are finalized, they are generally considered complete. However, living BITs are an |
96 | 96 | exception and can be updated regularly.
|
97 | 97 |
|
98 | 98 | ## Related Links
|
99 | 99 |
|
100 | 100 | - [Ethereum Improvement Proposals (EIPs)](https://eips.ethereum.org/)
|
101 |
| -- [Bitcoin Improvement Proposals (BIPs)](https://github.com/bitcoin/bips) |
| 101 | +- [Bitcoin Improvement Proposals (BIPs)](https://github.com/bitcoin/BIPs) |
102 | 102 |
|
103 | 103 | ## License
|
104 | 104 |
|
105 |
| -This repository and all BIPs are licensed under [The Unlicense](LICENSE). |
| 105 | +This repository and all BITs are licensed under [The Unlicense](LICENSE). |
106 | 106 |
|
107 | 107 | ---
|
108 | 108 |
|
109 | 109 | This repository is a work in progress, and we welcome your contributions and feedback to
|
110 |
| -improve the BIP process. |
| 110 | +improve the BITs process. |
0 commit comments