|
8 | 8 |
|
9 | 9 | - [Introduction](#introduction)
|
10 | 10 | - [Packages Overview](#packages-overview)
|
11 |
| -- [Getting Started for New Developers](#getting-started-for-new-developers) |
| 11 | +- [Getting Started](#getting-started) |
12 | 12 | - [Branches](#branches)
|
13 |
| -- [Package Dependency Relationships](#package-dependency-relationships) |
| 13 | +- [Packages Relationships](#packages-relationships) |
14 | 14 | - [EthereumJS](#ethereumjs)
|
15 | 15 | - [License](#license)
|
16 | 16 |
|
@@ -51,7 +51,7 @@ Below you can find a list of the packages included in this repository.
|
51 | 51 | | [@ethereumjs/vm][vm-package] | [![NPM Package][vm-npm-badge]][vm-npm-link] | [![VM Issues][vm-issues-badge]][vm-issues-link] | [![Actions Status][vm-actions-badge]][vm-actions-link] | [![Code Coverage][vm-coverage-badge]][vm-coverage-link] |
|
52 | 52 | | [@ethereumjs/wallet][wallet-package] | [![NPM Package][wallet-npm-badge]][wallet-npm-link] | [![StateManager Issues][wallet-issues-badge]][wallet-issues-link] | [![Actions Status][wallet-actions-badge]][wallet-actions-link] | [![Code Coverage][wallet-coverage-badge]][wallet-coverage-link] |
|
53 | 53 |
|
54 |
| -## Getting Started for New Developers |
| 54 | +## Getting Started |
55 | 55 |
|
56 | 56 | If you're new to the EthereumJS monorepo, this section will help you get up and running quickly.
|
57 | 57 |
|
@@ -170,19 +170,25 @@ You can find more detailed information on the configuration of different tooling
|
170 | 170 |
|
171 | 171 | ## Branches
|
172 | 172 |
|
| 173 | +### Overview |
| 174 | + |
173 | 175 | The following are our currently active branches:
|
174 | 176 |
|
175 | 177 | | Branch | Release Series | Status | Description |
|
176 | 178 | | --------------------------------------------------------------------------------------- | ---------------------- | ------------- | ---------------------------------------------- |
|
177 |
| -| [master](https://github.com/ethereumjs/ethereumjs-monorepo) | Upcoming (Autumn 2024) | `Develop` | Breaking release work | |
| 179 | +| [master](https://github.com/ethereumjs/ethereumjs-monorepo) | Upcoming (Spring 2025) | `Develop` | Breaking release work | |
178 | 180 | | [maintenance-v8](https://github.com/ethereumjs/ethereumjs-monorepo/tree/maintenance-v8) | v7/v8 | `Maintenance` | Maintenance for v8 releases (v7 also included) |
|
179 | 181 | | [maintenance-v6](https://github.com/ethereumjs/ethereumjs-monorepo/tree/maintenance-v6) | v6 | `Maintenance` | Maintenance for v6 releases |
|
180 | 182 |
|
181 |
| -Breaking releases are mostly done in sync for all libraries (latest exceptions: VM v8, EVM v3), and release cycles are currently named after the `@ethereumjs/vm` version. In most cases PRs should be opened towards the current working branch. If there is no current working branch, please ask! 🙂 |
| 183 | +### Breaking Releases |
| 184 | + |
| 185 | +Breaking releases are mostly done in sync for all libraries (latest exceptions: VM v8, EVM v3). Starting with the spring 2025 release series, we have aligned all package versions to have the same major version number. This makes it easier to clearly identify package versions compatible with each other as well as reason about functionality or bugs for a certain release series. |
| 186 | + |
| 187 | +Old release cycles up to the VM v7/v8 version were named after the `@ethereumjs/vm` version. In most cases PRs should be opened towards the current working branch. If there is no current working branch, please ask! 🙂 |
182 | 188 |
|
183 | 189 | To inspect code related to a specific package version, refer to the [tags](https://github.com/ethereumjs/ethereumjs-monorepo/tags).
|
184 | 190 |
|
185 |
| -## Package Dependency Relationships |
| 191 | +## Packages Relationships |
186 | 192 |
|
187 | 193 | ```mermaid
|
188 | 194 | graph TD
|
|
0 commit comments