Skip to content

Conversation

@harryswift01
Copy link
Contributor

Summary

This PR will introduce a new file a CITATION.cff file, the aim of this is to provide a standardised citation metadata for CodeEntropy, making it easier for users to properly cite the software in academic publications and repositories.

Changes

  • Introduction of CITATION.cff file:
  • Added author names, affiliations, ORCID IDs, and contact information
  • Included project title, abstract, and repository links
  • Specified relevant keywords for discoverability
  • Defined license (MIT)
  • Included version and release date fields

Impact

  • Improves the visibility and citability of CodeEntropy
  • Aligns the repository with best practices for open-source research software
  • Enables automatic citation generation in platforms like GitHub

@harryswift01 harryswift01 added this to the 1.0.0 release milestone Jul 7, 2025
@harryswift01 harryswift01 requested a review from jimboid July 7, 2025 10:10
@harryswift01 harryswift01 self-assigned this Jul 7, 2025
@harryswift01 harryswift01 linked an issue Jul 7, 2025 that may be closed by this pull request
Copy link
Member

@jimboid jimboid 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. I think the version being set at 0.3.6 is ok for now as long as we don't submit it anywhere like zenodo, since we don't want folks using that version. Safe to merge.

@harryswift01 harryswift01 merged commit dbafb90 into main Jul 7, 2025
7 checks passed
@harryswift01 harryswift01 deleted the 120-introduce-citationcff-file branch July 7, 2025 10:18
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.

Introduce CITATION.cff file

3 participants