Repository navigation
Document citation generation in the developer guide (fix #125) - #134
Conversation
| References an exact version of CodeMeta stored in the | ||
| [Software Heritage Archive](https://archive.softwareheritage.org), along with | ||
| its origin and a snapshot reference. The use of a SWHID allows for a precise | ||
| point in CodeMeta's history to be referenced. Future researchers will be able | ||
| to obtain the code at that precise point by looking up the SWHID in the Archive | ||
| or a mirror. |
There was a problem hiding this comment.
@progval, I see your point. SWH isn't introduced before this bit.
The text is accurate, showing that even CodeMeta can be referenced with a directory SWHID.
That may be too implicit.
With that, there might be room for two other items:
- CFF files: we always get the question of why use CodeMeta and not CFF for citation
- codemeta.json should not have a SWHID in it :) - for the race condition
There was a problem hiding this comment.
CFF files: we always get the question of why use CodeMeta and not CFF for citation
@moranegg I have no idea how to answer this so if you could point at a summary argument for why, it'd be useful.
There was a problem hiding this comment.
- Citation File Format (CFF) focuses strictly on how a software project should be cited. This can be an article, not the software.
- CodeMeta provides a comprehensive description with complete, descriptive metadata properties.
CodeMeta and CFF do not compete; they complement each other.
You can include a CITATION.cff file in your repository for clean, human-readable citations, alongside a codemeta.json file to give archives and indexers (like Zenodo or Software Heritage) full technical and administrative metadata about your project.
If a CFF exists, the citation feature at SWH will create the citation directly from the CFF and not from the CodeMeta.
For context: https://citation-file-format.github.io/
There was a problem hiding this comment.
i will rework this tomorrow
|
@moranegg is this more comfortable wording? It's more neutral about the archive while still explaining the difference the SWHID provides. I've done my best to explain the cff/codemeta differences without it being too much like a pitch. I've also added a warning admonition about hashes. Let me know if I've misunderstood or missed something important. |
3 participants
Please merge (or argue about) #137 first.