Skip to content

Introduce CITATION.cff file to formalise citation of the repository#16

Merged
harryswift01 merged 1 commit into
mainfrom
15-introduce-a-citationcff-file
Dec 10, 2025
Merged

Introduce CITATION.cff file to formalise citation of the repository#16
harryswift01 merged 1 commit into
mainfrom
15-introduce-a-citationcff-file

Conversation

@harryswift01
Copy link
Copy Markdown
Member

Summary

This PR introduces a standard CITATION.cff file for the repository, enabling users to properly cite the software and improving project documentation and academic traceability.

Changes

Add CITATION.cff boilerplate:

  • Adds a default CITATION.cff for citation metadata

Templated Repositories will be able to:

  • Update to reflect authorship
  • Link release version when published
  • Add DOI automatically if archived (e.g., Zenodo)

Impact

  • Enables formal citation of the repository
  • Supports research reproducibility and attribution
  • Standardizes project documentation

@harryswift01 harryswift01 self-assigned this Dec 10, 2025
@harryswift01 harryswift01 linked an issue Dec 10, 2025 that may be closed by this pull request
@harryswift01 harryswift01 merged commit 47da17c into main Dec 10, 2025
12 checks passed
@harryswift01 harryswift01 deleted the 15-introduce-a-citationcff-file branch December 10, 2025 16:35
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 a CITATION.cff file

1 participant