jbampton opened a new issue, #2559: URL: https://github.com/apache/sedona/issues/2559
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files Yes, adding a GitHub repository citation file, typically named **`CITATION.cff`**, would be appropriate and beneficial for Apache Sedona. ### 🌟 Why a `CITATION.cff` is Recommended A `CITATION.cff` file provides **human- and machine-readable** metadata on how users should cite the software (or dataset) correctly. For a major open-source project like Apache Sedona, this offers several advantages: * **GitHub Integration:** When a `CITATION.cff` file is present in the root of the repository's default branch, GitHub automatically displays a "Cite this repository" link in the sidebar of the repository page. This makes it **easy for users to find the correct citation** in formats like BibTeX and APA. * **Correct Metadata:** Software projects often evolve, and the right way to cite them (including the correct version, authors, and DOI) can be complex. The `CITATION.cff` allows the Apache Sedona developers to **specify the preferred citation** information, ensuring accuracy and consistency across academic and research papers. * **Archiving and DOIs:** If Apache Sedona integrates with services like **Zenodo**, the `CITATION.cff` file can be used to automatically populate the metadata when archiving a specific release and issuing a **Digital Object Identifier (DOI)**. This is crucial for academic discoverability and persistent referencing. * **Standard Format:** The Citation File Format (CFF) is an industry standard for software citation metadata, making the information reusable by citation managers (like Zotero) and other tools. ### 📚 Apache Sedona's Existing Citation Info The search results show that Apache Sedona already provides specific citation instructions, particularly for its R interface, including a BibTeX entry and a link to its GitHub repository. This demonstrates a clear intent and need for proper citation. Implementing a `CITATION.cff` would simply **standardize and streamline** this process directly within the main GitHub repository. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
