Skip to content

Commit d92cd6c

Browse files
committed
feat: adopt v1.0.0 GA versioning and compatibility policy
Update docs that described pre-1.0 versioning semantics to their post-1.0 form ahead of the v1.0.0 GA cut. Release-As: 1.0.0
1 parent 8d85e62 commit d92cd6c

3 files changed

Lines changed: 8 additions & 8 deletions

File tree

CLAUDE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ type(optional-scope): short imperative summary
1818

1919
- **Allowed types:** `feat`, `fix`, `perf`, `refactor`, `docs`, `test`,
2020
`build`, `ci`, `chore`, `style`, `revert`.
21-
- **Version impact (pre-1.0, `bump-minor-pre-major`):** `feat` -> minor
22-
(0.x.0), `fix`/`perf` -> patch. A breaking change uses a `!`
23-
(`feat!:` / `fix(core)!:`) or a `BREAKING CHANGE:` footer in the PR body;
24-
pre-1.0 a breaking change still bumps only the **minor** (0.x.0), NOT a
25-
major 1.0.0 - that is what `bump-minor-pre-major` means.
21+
- **Version impact (post-1.0):** `feat` -> minor (x.Y.0), `fix`/`perf` ->
22+
patch. A breaking change uses a `!` (`feat!:` / `fix(core)!:`) or a
23+
`BREAKING CHANGE:` footer in the PR body and bumps the **major** (X.0.0).
24+
(`bump-minor-pre-major` is still set in `release-please-config.json` but
25+
is inert now that the version is >= 1.0.0.)
2626
- Changelog-visible by default: `feat` (Features), `fix` (Bug Fixes), `perf`,
2727
`revert`, and `deps` (Dependencies). The rest - `docs`, `chore`, `ci`,
2828
`build`, `refactor`, `style`, `test` - are valid but **hidden**: a PR titled

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Format:
4242

4343
Common types:
4444

45-
- `feat`: a new user-facing feature (bumps the minor version pre-1.0)
45+
- `feat`: a new user-facing feature (bumps the minor version)
4646
- `fix`: a bug fix (bumps the patch version)
4747
- `docs`: documentation only
4848
- `refactor`: code change that neither fixes a bug nor adds a feature
@@ -52,7 +52,7 @@ Common types:
5252
- `perf`: a performance improvement
5353

5454
Breaking changes: add a `!` after the type/scope (for example `feat!:`) and / or
55-
a `BREAKING CHANGE:` footer. Pre-1.0, a breaking change bumps the minor version.
55+
a `BREAKING CHANGE:` footer. A breaking change bumps the major version.
5656

5757
Examples:
5858

design/SPEC.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1471,7 +1471,7 @@ jobs:
14711471
manifest-file: .release-please-manifest.json
14721472
```
14731473
1474-
Maintains a "chore: release v0.x.y" PR with the changelog and version
1474+
Maintains a "chore(main): release vX.Y.Z" PR with the changelog and version
14751475
bumps. Merging the PR creates the `v*` tag, which fires `release.yml`.
14761476

14771477
### 19.3 `release.yml`

0 commit comments

Comments
 (0)