Skip to content
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

Update release.md #1059

Closed
wants to merge 1 commit into from
Closed

Update release.md #1059

wants to merge 1 commit into from

Conversation

mavaylon1
Copy link
Contributor

@mavaylon1 mavaylon1 commented Feb 22, 2024

Motivation

What was the reasoning behind this change? Please explain the changes briefly.
Remove a duplicate bullet point.

How to test the behavior?

Show how to reproduce the new behavior (can be a bug fix or a new feature)

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Does the PR clearly describe the problem and the solution?
  • Have you reviewed our Contributing Guide?
  • Does the PR use "Fix #XXX" notation to tell GitHub to close the relevant issue numbered XXX when the PR is merged?

@mavaylon1 mavaylon1 self-assigned this Feb 22, 2024
Copy link

codecov bot commented Feb 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.53%. Comparing base (0998190) to head (b7e0316).
Report is 58 commits behind head on dev.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #1059   +/-   ##
=======================================
  Coverage   88.53%   88.53%           
=======================================
  Files          45       45           
  Lines        9605     9605           
  Branches     2732     2732           
=======================================
  Hits         8504     8504           
  Misses        778      778           
  Partials      323      323           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@stephprince
Copy link
Contributor

There's nothing in the README.rst other than the legal file dates that gets updated usually, right? I was wondering if that's why they were separate steps originally.

@mavaylon1
Copy link
Contributor Author

My view is that "checking information" is the same as "Update". I think this is just an interpretation. I'll leave this as is.

@mavaylon1 mavaylon1 closed this Feb 22, 2024
@oruebel
Copy link
Contributor

oruebel commented Feb 22, 2024

Originally the README contained more detailed information, e.g,. about installing HDMF, so there was more to check then just the legal dates. In general, checking the README is there to make sure it is up-to-date with any changes that have happened in the repo, since this is the first thing developers see when they come to the repo.

Case in point, currently there is a broken badge in the README that points to a non-existing GitHub workflow:

Screen Shot 2024-02-22 at 9 26 48 AM

It looks like the broken badge is pointing to check_external_links.yml, which I assume has been renamed to check_sphinx_links.yml

I think taking a look at the README before a release is still a good idea, even if no actions are needed in most cases.

@rly rly deleted the duplicate branch February 25, 2024 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants