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

Added citation.cff #173

Closed
wants to merge 6 commits into from
Closed

Added citation.cff #173

wants to merge 6 commits into from

Conversation

jmafoster1
Copy link
Contributor

I added a citation.cff file to make it easier to cite the repo in publications. If you could please add your ORCID ID if you have one and check I've not missed any authors off, that'd be much appreciated.

@github-actions
Copy link

github-actions bot commented Mar 28, 2023

🦙 MegaLinter status: ⚠️ WARNING

Descriptor Linter Files Fixed Errors Elapsed time
⚠️ PYTHON black 24 1 1.8s
✅ PYTHON pylint 24 0 5.66s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

@codecov
Copy link

codecov bot commented Mar 28, 2023

Codecov Report

Merging #173 (502c3f8) into main (83584a7) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #173   +/-   ##
=======================================
  Coverage   93.24%   93.24%           
=======================================
  Files          19       19           
  Lines        1303     1303           
=======================================
  Hits         1215     1215           
  Misses         88       88           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7e01033...502c3f8. Read the comment docs.

@jmafoster1 jmafoster1 marked this pull request as ready for review March 28, 2023 13:33
Copy link
Contributor

@bobturneruk bobturneruk 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. Very much in favour of citing software directly, rather than related papers.

citation.cff Show resolved Hide resolved
- family-names: Wild
given-names: Christopher
title: "Causal Testing Framework"
version: 3.1.0
Copy link
Contributor

Choose a reason for hiding this comment

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

@cwild-UoS can this (and below) be automatically updated somehow?

Copy link
Contributor

Choose a reason for hiding this comment

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

After a fair bit of digging around I can't find any tools or workflows to currently do this. I've found a good discussion on this in another project.

Copy link
Contributor

Choose a reason for hiding this comment

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

It's tricky. Might need to be done by hand for now. Similar problem for ORDA releases.

Co-authored-by: bobturneruk <[email protected]>
@christopher-wild
Copy link
Contributor

Decided to cite with Figshare, PR with instructions on how to cite to soon follow

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.

4 participants