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

Add citability measure #120

Merged
merged 6 commits into from
Oct 23, 2024
Merged

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Oct 22, 2024

Description

This PR adds a simplified citability measure that looks for a CITATION.cff, CITATION.bib, or a sub-header in a README.md which includes "Citation" or "Citing". I think we could improve upon this with more complex checking, but I didn't want to advance on premature enhancements here before better understanding what we might encounter in the wider ecosystem.

Along the journey for this PR I also opted to enhance tests from #115 so we may rapidly test repository scenarios using a repo_setup utility function and parameterized tests.

Closes #107

What is the nature of your change?

  • Content additions or updates (adds or updates content)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own contributions.
  • I have commented my content, particularly in hard-to-understand areas.
  • I have made corresponding changes to related documentation (outside of book content).
  • My changes generate no new warnings.
  • New and existing tests pass locally with my changes.
  • I have added tests that prove my additions are effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

src/almanack/metrics/data.py Outdated Show resolved Hide resolved
src/almanack/metrics/metrics.yml Outdated Show resolved Hide resolved
@d33bs
Copy link
Member Author

d33bs commented Oct 23, 2024

Thanks @gwaybio ! After addressing your comments going to merge this in.

@d33bs d33bs merged commit 29ca220 into software-gardening:main Oct 23, 2024
11 checks passed
@d33bs d33bs deleted the citation-measure branch October 23, 2024 20:59
@d33bs d33bs linked an issue Nov 12, 2024 that may be closed by this pull request
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.

Biomedical research meaningful measures: Table 3 - Citability Implement software citability metric
2 participants