You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38Lines changed: 38 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,6 +46,44 @@ To see more options, use `--help`.
46
46
47
47
## Further information
48
48
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
+
49
87
### Working with docker containers
50
88
51
89
**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