Refactor script for checking CITATION.cff
#2524
Conversation
github-actions
bot
added
the
GitHub Actions
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2524 +/- ##
==========================================
+ Coverage 96.93% 97.36% +0.42%
==========================================
Files 104 104
Lines 9163 9361 +198
==========================================
+ Hits 8882 9114 +232
+ Misses 281 247 -34 ☔ View full report in Codecov by Sentry. |
namurphy
requested review from
ejohnson-96
and removed request for
a team and
ejohnson-96
|
|
||
| - given-names: <given names> | ||
| family-names: <family names> | ||
| affiliation: <affiliation> | ||
| orcid: https://orcid.org/<ORCiD number> | ||
| alias: {missing_github_username} | ||
| email: <email address> |
There was a problem hiding this comment.
We don't have a need for people's emails, so we can remove this. Plus, very few people have added the email field to their CITATION.cff entry, except for the most frequent contributors.
|
|
||
| The entry should be of the form: | ||
| https://github.com/{username}/PlasmaPy/edit/{branch}/CITATION.cff |
There was a problem hiding this comment.
This link was incorrect before since it pointed to PlasmaPy/PlasmaPy instead of the fork.
This PR does some refactoring of the script that checks whether each author of a pull request is included in
CITATION.cff.This PR also fixes an error in the link to edit
CITATION.cff. The link had previously pointed to thePlasmaPy/PlasmaPyrepo instead of the fork. It does still assume that the fork is named "PlasmaPy" which will be true most of the time but possibly not all.