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 README to reflect move to GitHub Discussions #4375

Merged
merged 4 commits into from
Dec 22, 2023
Merged

Conversation

RMeli
Copy link
Member

@RMeli RMeli commented Dec 21, 2023

Remove mailing list badges and update links.
Copy link

github-actions bot commented Dec 21, 2023

Linter Bot Results:

Hi @RMeli! Thanks for making this PR. We linted your code and found the following:

Some issues were found with the formatting of your code.

Code Location Outcome
main package ⚠️ Possible failure
testsuite ✅ Passed

Please have a look at the darker-main-code and darker-test-code steps here for more details: https://github.com/MDAnalysis/mdanalysis/actions/runs/7293816302/job/19877570983


Please note: The black linter is purely informational, you can safely ignore these outcomes if there are no flake8 failures!

Copy link

codecov bot commented Dec 21, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (abee0bb) 93.41% compared to head (f90d40c) 93.41%.

Additional details and impacted files
@@            Coverage Diff             @@
##           develop    #4375     +/-   ##
==========================================
  Coverage    93.41%   93.41%             
==========================================
  Files          171      185     +14     
  Lines        22511    23625   +1114     
  Branches      4129     4129             
==========================================
+ Hits         21028    22069   +1041     
- Misses         963     1036     +73     
  Partials       520      520             

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

@RMeli RMeli requested a review from orbeckst December 21, 2023 20:27
Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

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

This looks fine. Maybe generate a banner with shield.io for GH Discussions in their place?

Please check other places such as https://github.com/MDAnalysis/mdanalysis/blob/develop/package/pyproject.toml (and setup.py?) ... I'd git grep the whole source tree.

Thanks for the update... sorry for brevity.

@RMeli
Copy link
Member Author

RMeli commented Dec 21, 2023

@orbeckst, very good point. I didn't look past the readme. I now added the shield and removed all occurrences. I also toned down the "question" issue template, since it would be trivial now to migrate an issue to a discussion.

Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

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

Thank you for the thorough scouring of the docs — there were more places than I thought. LGTM

Other places:

  • Could you please also look at the UG? I assume we have similar occurrences there.
  • Did you change the website?
  • Teaching materials? — These can probably be updated as we go along.
  • MDAKits??

@orbeckst
Copy link
Member

@RMeli please squash-merge when you're happy with it.

@RMeli
Copy link
Member Author

RMeli commented Dec 21, 2023

Yes, I'll look at the other places in the coming days, thanks for bringing this up!

@RMeli RMeli merged commit 2d1d684 into develop Dec 22, 2023
23 checks passed
@RMeli RMeli deleted the readme-discussions branch December 22, 2023 07:09
ljwoods2 pushed a commit to ljwoods2/mdanalysis that referenced this pull request Dec 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants