-
Notifications
You must be signed in to change notification settings - Fork 12
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
Document release flow in README.md
#164
Conversation
Point to GitHub Releases instead and updates PR template with instructions
README.md
Outdated
Releases are managed via the GitHub UI: | ||
|
||
1. [Draft a new release](https://github.com/higlass/higlass-python/releases/new) | ||
2. **Create a tag** in the format `v[major].[minor].[patch]`. |
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.
As per the Slack conversation, I recommend making 2. a sub item of 1 so that it's clear that the tag is created during the release process.
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.
Since all the steps that follow are a part of "drafting a release", I reorganized things. Let me know hwat you think.
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.
Looks good 👍
a790276
to
13c21e5
Compare
Documents the full release flow via the GitHub UI.
Also removes
CHANGELOG.md
to avoid redundancy. Points to GitHub Releases instead and updates PR template withinstructions.