|
1 | 1 | # Protocol Buffers
|
2 | 2 |
|
3 |
| -This sections defines the types and messages shared across implementations. The definition of the data structures are located in the [core/data_structures](../spec/core/data_structures.md) for the core data types and ABCI definitions are located in the [ABCI](../spec/abci/README.md) section. |
| 3 | +This sections defines the types and messages shared across implementations. The |
| 4 | +definition of the data structures are located in the |
| 5 | +[core/data\_structures](../spec/core/data_structures.md) for the core data types |
| 6 | +and ABCI definitions are located in the [ABCI](../spec/abci/README.md) section. |
4 | 7 |
|
5 | 8 | ## Process of Updates
|
6 | 9 |
|
7 |
| -The `.proto` files within this section are core to the protocol and updates must be treated as such. |
| 10 | +The `.proto` files within this section are core to the protocol and updates must |
| 11 | +be treated as such. |
8 | 12 |
|
9 | 13 | ### Steps
|
10 | 14 |
|
11 |
| -1. Make an issue with the proposed change. |
12 |
| - - Within in the issue members from both the CometBFT and Tendermint-rs team will leave comments. If there is not consensus on the change an [RFC](../docs/rfc/README.md) may be requested. |
13 |
| - 1a. Submission of an RFC as a pull request should be made to facilitate further discussion. |
14 |
| - 1b. Merge the RFC. |
15 |
| -2. Make the necessary changes to the `.proto` file(s), [core data structures](../spec/core/data_structures.md) and/or [ABCI protocol](../spec/abci). |
16 |
| -3. Open issues within CometBFT and Tendermint-rs repos. This is used to notify the teams that a change occurred in the spec. |
17 |
| - 1. Tag the issue with a spec version label. This will notify the team the changed has been made on master but has not entered a release. |
| 15 | +1. Make an issue with the proposed change. Within in the issue members from |
| 16 | + both the CometBFT and tendermint-rs team will leave comments. If there is not |
| 17 | + consensus on the change an [RFC](../docs/rfc/README.md) may be requested. |
| 18 | + 1. Submission of an RFC as a pull request should be made to facilitate |
| 19 | + further discussion. |
| 20 | + 2. Merge the RFC. |
| 21 | +2. Make the necessary changes to the `.proto` file(s), [core data |
| 22 | + structures](../spec/core/data_structures.md) and/or [ABCI |
| 23 | + protocol](../spec/abci). |
| 24 | +3. Open issues within CometBFT and Tendermint-rs repos. This is used to notify |
| 25 | + the teams that a change occurred in the spec. |
| 26 | + 1. Tag the issue with a spec version label. This will notify the team the |
| 27 | + changed has been made on master but has not entered a release. |
18 | 28 |
|
19 | 29 | ### Versioning
|
20 | 30 |
|
21 |
| -The spec repo aims to be versioned. Once it has been versioned, updates to the protobuf files will live on master. After a certain amount of time, decided on by CometBFT and tendermint-rs team leads, a release will be made on the spec repo. The spec may contain minor releases as well, depending on the implementation these changes may lead to a breaking change. If so, the implementation team should open an issue within the spec repo requiring a major release of the spec. |
22 |
| - |
23 |
| -If the steps above were followed each implementation should have issues tagged with a spec change label. Once all issues have been completed the team should signify their readiness for release. |
| 31 | +The spec repo aims to be versioned. Once it has been versioned, updates to the |
| 32 | +protobuf files will live on master. After a certain amount of time, decided on |
| 33 | +by CometBFT and tendermint-rs team leads, a release will be made on the spec |
| 34 | +repo. The spec may contain minor releases as well, depending on the |
| 35 | +implementation these changes may lead to a breaking change. If so, the |
| 36 | +implementation team should open an issue within the spec repo requiring a major |
| 37 | +release of the spec. |
| 38 | + |
| 39 | +If the steps above were followed each implementation should have issues tagged |
| 40 | +with a spec change label. Once all issues have been completed the team should |
| 41 | +signify their readiness for release. |
0 commit comments