Skip to content

DOC/ENH: use CITATION.cff#156

Merged
aburrell merged 12 commits intoaburrell:developfrom
jklenzing:enh/136_citation
Aug 8, 2025
Merged

DOC/ENH: use CITATION.cff#156
aburrell merged 12 commits intoaburrell:developfrom
jklenzing:enh/136_citation

Conversation

@jklenzing
Copy link
Copy Markdown
Contributor

Description

  • Updates the code to use CITATION.cff as primary record of authorship.
  • Includes cff-validator action in GitHub Actions.
  • Updates docs to point contributors to CITATION.cff.
  • Updates maintenance doc to describe method of generating .zenodo.json from CITATION.cff
  • Updates maintenance doc to remove discussion of wheels (removed in BUG: GitHub Actions and artifact upload, broken doc links #154)

Fixes #136

Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

install cffconvert via pip

cffconvert --validate

Test Configuration

  • Operating system: Mac Os X
  • Python version number: 3.12.6
  • Compiler with version number: gfortran 14.2
  • Relevant local setup details: n/a

Checklist

  • Make sure you are merging into the develop (not main) branch
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • Add a note to Changelog.rst, summarising the changes
  • Add yourself to AUTHORS.rst and .zenodo.json

@coveralls
Copy link
Copy Markdown

coveralls commented May 8, 2025

Pull Request Test Coverage Report for Build 16837472598

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 99.701%

Totals Coverage Status
Change from base Build 13998411214: 0.0%
Covered Lines: 999
Relevant Lines: 1002

💛 - Coveralls

@aburrell
Copy link
Copy Markdown
Owner

aburrell commented Aug 8, 2025

Docs are failing for a readme line that I can't find.

Code climate seems to have changed hands, removing the badge.
@jklenzing
Copy link
Copy Markdown
Contributor Author

jklenzing commented Aug 8, 2025

Docs are failing for a readme line that I can't find.

It's for the codeclimate badge. If I use the direct link I get a server error message. Not sure if the service is down or something changed on the back end EDIT: looks like you already found it.

@aburrell
Copy link
Copy Markdown
Owner

aburrell commented Aug 8, 2025

MacOS failures captured in #157

@aburrell aburrell merged commit 22adf25 into aburrell:develop Aug 8, 2025
23 of 27 checks passed
@aburrell aburrell added this to the 2.1.1 milestone Aug 8, 2025
@jklenzing jklenzing deleted the enh/136_citation branch August 8, 2025 20:39
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.

3 participants