Skip to content

fix badges + readme updates #309

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.

Sign up for GitHub

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

Jump to bottom
Merged
mikemhenry merged 7 commits into from
Nov 1, 2023
Merged

fix badges + readme updates #309

mikemhenry merged 7 commits into from
Nov 1, 2023

Conversation

@mikemhenry
Copy link
Collaborator

@mikemhenry mikemhenry commented Oct 31, 2023

No description provided.

@mikemhenry
Copy link
Collaborator Author

mikemhenry commented Oct 31, 2023

This is what the badges look like now:
image

I still need to make some changes mentioned in #308 before this PR is reviewed

@mikemhenry
Copy link
Collaborator Author

mikemhenry commented Oct 31, 2023

https://arxiv.org/abs/2010.01196 @jchodera is this still the best reference for espaloma?

@mikemhenry
Copy link
Collaborator Author

mikemhenry commented Oct 31, 2023 •
edited
Loading

TODO: Update changelog section in README Done.

@codecov-commenter
Copy link

codecov-commenter commented Oct 31, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9eb2e49) 68.03% compared to head (1f82079) 68.03%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #309   +/-   ##
=======================================
  Coverage   68.03%   68.03%           
=======================================
  Files           5        5           
  Lines         879      879           
=======================================
  Hits          598      598           
  Misses        281      281

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

@mikemhenry mikemhenry requested a review from jchodera October 31, 2023 19:21
@mikemhenry mikemhenry marked this pull request as ready for review October 31, 2023 19:25
mattwthompson
mattwthompson approved these changes Oct 31, 2023
View reviewed changes
Copy link
Collaborator

@mattwthompson mattwthompson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The diff looks good to me; I checked that badges render and have links that go places. A couple of minor suggestions that came to mind as well

README.md Outdated
* `amber/` - AMBER force fields and conversion tools
* `charmm/` - CHARMM force fields and conversion tools

# Changelog
Copy link
Collaborator

@mattwthompson mattwthompson Oct 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at the history, the release notes on GitHub are pretty consistently good: https://github.com/openmm/openmmforcefields/releases

Might be worth adding a link to the header of this section?

Copy link
Collaborator Author

@mikemhenry mikemhenry Oct 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, I do that for the next change log entry but it makes sense to highlight it here.

Copy link
Collaborator

@mattwthompson mattwthompson Oct 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I figure the high-level link gets most of the value of adding per-release links like you did, but with less work

@mikemhenry
Copy link
Collaborator Author

mikemhenry commented Oct 31, 2023

I asked on our espaloma slack for the best citation to use, once I get that I will update this PR and merge it in, thanks for the review @mattwthompson

@mattwthompson
Copy link
Collaborator

mattwthompson commented Oct 31, 2023

Out of scope here, but if you ever wanted to make an attempt to make big Markdown files more consistent, here's a hook I've been using to some success:

- repo: https://github.com/igorshubovych/markdownlint-cli
  rev: v0.37.0
  hooks:
  - id: markdownlint
    exclude: .github
    args: ["--disable", "MD013", "MD033", "MD024", "MD046", "--ignore", "any/specific/file.md", "--"]

jchodera
jchodera approved these changes Oct 31, 2023
View reviewed changes
Copy link
Member

@jchodera jchodera left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good---thanks!

@mikemhenry mikemhenry merged commit 637d551 into main Nov 1, 2023
@mikemhenry mikemhenry deleted the fix/issue_308 branch November 1, 2023 13:53
@mikemhenry mikemhenry mentioned this pull request Nov 1, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mattwthompson mattwthompson mattwthompson approved these changes

@jchodera jchodera jchodera approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@mikemhenry @codecov-commenter @mattwthompson @jchodera