-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add release.md #5
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you fix typos in README.md
too?
@@ -0,0 +1,35 @@ | |||
Release procedure | |||
================= |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you don't have strong opinion to maintain this mixed syntax, it seems better to follow the standard defined by markdownlint.
https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md003.md
```console | ||
# Set VERSION and confirm it. It should not have "v" prefix. | ||
$ VERSION=x.y.z | ||
$ echo $VERSION | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar to the comment above, it seems better to follow the markdownlint, that is replacing console
with sh
and remove $
s.
https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md014.md
```console | ||
$ git checkout main | ||
$ git tag -a -m "Release v$VERSION" "v$VERSION" | ||
$ git tag -ln | grep $VERSION | ||
$ git push origin v$VERSION | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ditto
Added due to missing release procedures
I would like to know if there are any md's that I should add to the docs file.
Currently it looks good to have at least this much