Skip to content

Commit 336ba2b

Browse files
authored
docs(dev): add Step 0 to release process runbook
Captures the convention introduced in the 0.6.1 cycle: before preparing the changelog or branching, open a GitHub issue to coordinate the release, explain why we are cutting it now, and list any unusual pre-release todos. Routine steps are already covered by this runbook and need not be repeated.
1 parent 8b75e38 commit 336ba2b

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

doc/dev/release-process.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,25 @@ It captures lessons learned from the 0.5.1 incident (#517) and the 0.6.0 cycle.
1313

1414
---
1515

16+
## Step 0 — Open a release issue
17+
18+
Before preparing the changelog or branching, open a GitHub issue for the
19+
release and assign it to the person driving the release. The issue should:
20+
21+
1. Explain why we are cutting a release now (milestone complete, enough fixes
22+
accumulated, dependency compatibility update, etc.).
23+
2. Summarize what is in the release: major bug fixes, new features, infra
24+
updates (Python version, SymPy version, tooling changes).
25+
3. List any **unusual** pre-release todos as a checklist. Routine steps
26+
(version bump, RC tag, smoke test) do not need listing — those are covered
27+
by this runbook. Only add items specific to this release cycle
28+
(e.g. "merge #587 before releasing", "update changelog for #585").
29+
30+
The issue is the coordination point and gives contributors visibility into
31+
what is going into the release.
32+
33+
---
34+
1635
## Step 1 — Prepare the changelog
1736

1837
1. Ensure all PRs intended for the release are merged and have entries in

0 commit comments

Comments
 (0)