Skip to content

Commit d744c52

Browse files
committed
Add note about breaking releases
1 parent bd7cbfe commit d744c52

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

developers/contributing/index.qmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,8 @@ Release notes:
113113
[YOUR RELEASE NOTES HERE]
114114
```
115115

116+
If you are making a breaking release, your release notes must also contain the string `Breaking changes` somewhere in them (this is mandated by the `@JuliaRegistrator` bot, described below).
117+
116118
The `@JuliaRegistrator` bot will handle creating a pull request into the Julia central package repository and tagging a new release in the repository.
117119
The release notes should be a copy-paste of the notes written in `HISTORY.md` if such an entry exists, or otherwise (for a patch release) a short summary of changes.
118120

0 commit comments

Comments
 (0)