-
Notifications
You must be signed in to change notification settings - Fork 663
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
MDAnalysis.analysis.rms.rmsd docs fixed version entries #4022
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.
Hello there first time contributor! Welcome to the MDAnalysis community! We ask that all contributors abide by our Code of Conduct and that first time contributors introduce themselves on the developer mailing list so we can get to know you. You can learn more about participating here. Please also add yourself to package/AUTHORS
as part of this PR.
Codecov ReportBase: 93.52% // Head: 93.52% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## develop #4022 +/- ##
========================================
Coverage 93.52% 93.52%
========================================
Files 190 190
Lines 25028 25028
Branches 3542 3542
========================================
Hits 23407 23407
Misses 1100 1100
Partials 521 521
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
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.
Hi @MeetB7 , this looks good, nice and clean work! 👍
Please also do the following
- add yourself to the AUTHORS file
- add your GitHub handle to the top of CHANGELOG (where you see the other people who contributed to the 2.5.0 release); you don't need an entry but you should be credited as a contributor
- introduce yourself on the mdanalysis-developer list, please (reference this PR in your message), see https://www.mdanalysis.org/#participating
Please ping me with @orbeckst when you've done everything. This will notify me, otherwise I might not remember to look at the PR (sorry, I am busy with many different things)
Once you've done all of the above, I can merge your first contribution!
Hi @MeetB7 , please also add yourself to CHANGELOG and Resolve the conflicts. Otherwise it cannot be merged. |
Hey @orbeckst i have made the changes and my pr is ready to merge. |
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.
-
Did you check the built docs and visually confirmed that the version changed now show up? There's a read the docs check that leads you to the built docs. Please paste the link to the page where the rmsd docs are displayed and confirm that it looks good.
-
There's one line break issue in the CHANGELOG. I created a suggestion for a fix. Just commit my suggestion by pressing the nice "Commit suggestion" button.
Looks good to me, thank you, I am just waiting for you to do the two things.
Co-authored-by: Oliver Beckstein <[email protected]>
Yeah the version entries now show up in the docs @orbeckst |
Thank you for your first contribution @MeetB7 , well done 🎉 |
Thank you for guiding me through it. I can't wait to contribute more in future. |
Fixes #4014
Changes made in this Pull Request:
PR Checklist