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: doc/developer_documentation.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ These notes generally assume you are on a Linux system.
40
40
-[autoformating code](#autoformat)
41
41
-[with clang-format](#autoformat.clang-format)
42
42
43
-
# <aname="release-checklist"></a>Compatibility guarantees across versions
43
+
# <a name="compatibility></a>Compatibility guarantees across versions
44
44
45
45
A *bug* is bad behavior that wasn't intended. For example, the program crashing instead of returning empty results when sampling from an empty circuit would be a bug.
46
46
@@ -67,9 +67,12 @@ A *spandrel* is an implementation detail that has observable effects, but which
67
67
- Commit changes
68
68
-`git tag vX.Y.Z`
69
69
- Push tag to github
70
+
- Check github `Actions` tab and confirm ci is running on the tag
71
+
- Wait for ci to finish validating and producing artifacts for the tag
70
72
- Get `stim` wheels [from cibuildwheels](#pypackage.stim.cibuildwheels) of this tag
71
73
- Build `stimcirq` sdist on this tag [using python setup.py sdist](#pypackage.stimcirq.python)
72
-
- Combine `stim` and `stimcirq` package files into one directory
74
+
- Build `sinter` sdist on this tag [using python setup.py sdist](#pypackage.sinter.python)
75
+
- Combine `stim`, `stimcirq`, and `sinter` package files into one directory
73
76
- Bump to next dev version on main branch
74
77
- Update version to `vX.Y.dev0` in all setup.py files
75
78
- Update `INTENTIONAL_VERSION_SEED_INCOMPATIBILITY` in `src/stim/circuit/circuit.h`
@@ -79,7 +82,7 @@ A *spandrel* is an implementation detail that has observable effects, but which
79
82
- Flagship changes section
80
83
- Notable changes section
81
84
- Include wheels/sdists as attachments
82
-
- Do irreversible steps last
85
+
- Do these irreversible and public viewable steps last!
83
86
- Upload wheels/sdists to pypi using `twine`
84
87
- Publish the github release notes
85
88
- Add gates reference page to wiki for the new version
0 commit comments