[GH-2559] Add CITATION.cff file for proper software citation #2602
Conversation
- Add CITATION.cff file to enable GitHub's 'Cite this repository' feature - Include software metadata: version 1.8.0, Apache 2.0 license, project URLs - Set preferred citation to foundational Geoinformatica 2019 paper (DOI: 10.1007/s10707-018-0330-9) as recommended in project docs - Follow Citation File Format (CFF) v1.2.0 specification - Include key authors with ORCID identifiers where available Fixes apache#2559
CITATION.cff
Outdated
| preferred-citation: | ||
| type: article | ||
| title: "Spatial Data Management in Apache Spark: The GeoSpark Perspective and Beyond" | ||
| authors: | ||
| - family-names: "Yu" | ||
| given-names: "Jia" | ||
| - family-names: "Zhang" | ||
| given-names: "Zongsi" | ||
| - family-names: "Sarwat" | ||
| given-names: "Mohamed" | ||
| doi: "10.1007/s10707-018-0330-9" | ||
| journal: "GeoInformatica" | ||
| year: 2019 | ||
| url: "https://jiayuasu.github.io/files/paper/GeoSpark_Geoinformatica_2018.pdf" |
There was a problem hiding this comment.
I think we want to cite the main Sedona software and not the past original. Perhaps we should remove the preferred-citation section. Up for discussion
There was a problem hiding this comment.
Is it possible to provide more info like this
Yu, Jia, Zongsi Zhang, and Mohamed Sarwat. "Spatial data management in apache spark: the geospark perspective and beyond." GeoInformatica 23.1 (2019): 37-78.
There was a problem hiding this comment.
Thanks for the reviews I have removed the preferred-citation section as suggested by @jbampton to ensure the Sedona software itself is cited by default.
@jiayuasu To answer your question yes, CFF fully supports fields like volume, issue, and pages. If the project decides to prefer the paper citation over the software in the future, we can easily add that section back with the specific details you mentioned.
Subham-KRLX
force-pushed
the
add-citation-file
branch
from
94f1386 to
5b3f31d
Compare
CITATION.cff
Outdated
| license: Apache-2.0 | ||
| authors: | ||
| - name: "The Apache Software Foundation" | ||
| - family-names: "Yu" |
There was a problem hiding this comment.
Can you remove Jia, Yitao from the author list? The author should be ASF
CITATION.cff
Outdated
| type: software | ||
| title: "Apache Sedona" | ||
| version: 1.8.0 | ||
| date-released: "2025-01-24" |
There was a problem hiding this comment.
date and version are not correct.
- Remove Jia Yu and Yitao Li from authors list (keep only ASF) - Update version to 1.8.1-SNAPSHOT to match pom.xml - Remove date-released field (SNAPSHOT versions don't have release dates)
3 participants
Add CITATION.cff file to enable GitHub's 'Cite this repository' feature with proper software metadata and preferred citation to the Geoinformatica 2019 paper.
Fixes #2559
Did you read the Contributor Guide?
Is this PR related to a ticket?
[GH-XXX] my subject. Closes We can add a CITATION file to the repository to help users correctly cite the Sedona software #2559What changes were proposed in this PR?
Added CITATION.cff file with:
This enables GitHub's automatic citation feature and provides standardized citation formats.
How was this patch tested?
Validated against CFF v1.2.0 specification and verified metadata accuracy from pom.xml, R/DESCRIPTION, and docs/community/publication.md.
Did this PR include necessary documentation updates?