xcdat icon indicating copy to clipboard operation
xcdat copied to clipboard

Add `.zenodo.json` and `CITATION.cff` to cite core authors

Open tomvothecoder opened this issue 8 months ago • 1 comments

Description

This pull request adds metadata files to enhance citation and attribution for the xCDAT project. The changes include the addition of a .zenodo.json file for Zenodo integration and a CITATION.cff file for standardized citation formatting.

Metadata Additions:

  • .zenodo.json: Added a file specifying project creators, their affiliations, and ORCID identifiers to enable proper attribution when the project is archived on Zenodo.

  • CITATION.cff: Added a file providing citation details, including project title, abstract, DOI, license, repository link, and preferred citation format, to facilitate standardized referencing of the xCDAT project.

Checklist

  • [x] My code follows the style guidelines of this project
  • [x] I have performed a self-review of my own code
  • [x] My changes generate no new warnings
  • [x] Any dependent changes have been merged and published in downstream modules

If applicable:

  • [ ] I have added tests that prove my fix is effective or that my feature works
  • [ ] New and existing unit tests pass with my changes (locally and CI/CD build)
  • [ ] I have commented my code, particularly in hard-to-understand areas
  • [ ] I have made corresponding changes to the documentation
  • [ ] I have noted that this is a breaking change for a major release (fix or feature that would cause existing functionality to not work as expected)

tomvothecoder avatar May 14 '25 20:05 tomvothecoder

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (14f876b) to head (e960f7f). Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #759   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           16        16           
  Lines         1702      1702           
=========================================
  Hits          1702      1702           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar May 14 '25 20:05 codecov[bot]