Skip to content

Commit ff66845

Browse files
Merge pull request #107 from OffchainLabs/branch-explanation
Branch explanation in readme
2 parents af85176 + 1164f7e commit ff66845

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,44 @@ To see more options, use `--help`.
4646

4747
## Further information
4848

49+
### Branch Selection Guide (for devs working *on* nitro-testnode)
50+
51+
This repository maintains two main branches with distinct purposes.
52+
53+
#### `release` branch
54+
55+
Target branch for changes that should be immediately available to external users.
56+
57+
**Examples of changes for `release`:**
58+
* Bug fixes for existing functionality
59+
* Documentation improvements
60+
* Updates to support newly released Nitro features
61+
* Configuration updates for published Nitro releases
62+
63+
> 💡 Changes here will later be merged into `master`
64+
65+
#### `master` branch
66+
67+
Target branch for changes supporting unreleased Nitro features.
68+
69+
**Examples of changes for `master`:**
70+
* Support for new configuration options being developed in Nitro
71+
* Integration tests for upcoming Nitro features
72+
* Breaking changes that depend on unreleased Nitro versions
73+
74+
> 💡 Changes here will be merged into `release` when the corresponding Nitro features are released
75+
76+
#### Branch Flow
77+
78+
##### For immediate public consumption
79+
1. Push to `release`
80+
2. Later merge into `master`
81+
82+
##### For unreleased Nitro features
83+
1. Push to `master`
84+
2. Merge into `release` when the feature is released
85+
86+
4987
### Working with docker containers
5088

5189
**sequencer** is the main docker to be used to access the nitro testchain. It's http and websocket interfaces are exposed at localhost ports 8547 and 8548 ports, respectively.

0 commit comments

Comments
 (0)