Skip to content

Commit

Permalink
docs: escape <major> etc in hacking.md (#1294)
Browse files Browse the repository at this point in the history
GH markdown converts angle-bracketed words into HTML tags, which, being
unknown, are ignored by the browser.
  • Loading branch information
dimaqq authored Jul 22, 2024
1 parent f12df1f commit cdf475f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ To make a release of the ops library, do the following:

1. Visit the [releases page on GitHub](https://github.com/canonical/operator/releases).
2. Click "Draft a new release"
3. The "Release Title" is simply the full version number, in the form <major>.<minor>.<patch>
3. The "Release Title" is simply the full version number, in the form `<major>.<minor>.<patch>`
and a brief summary of the main changes in the release
E.g. 2.3.12 Bug fixes for the Juju foobar feature when using Python 3.12
4. Use the "Generate Release Notes" button to get a copy of the changes into the
Expand Down

0 comments on commit cdf475f

Please sign in to comment.