Citation File Format · API Governance Rules
Citation File Format API Rules
Spectral linting rules defining API design standards and conventions for Citation File Format.
10 Rules
error 4
warn 6
Rule Categories
cff
Rules
error
cff-version-required
A CITATION.cff file MUST declare a cff-version field.
#CitationCff
warn
cff-version-current
cff-version SHOULD be 1.2.0 to use the current schema.
#CitationCff.cff-version
error
cff-message-required
A CITATION.cff file MUST contain a message field.
#CitationCff
error
cff-title-required
A CITATION.cff file MUST contain a title field.
#CitationCff
error
cff-authors-required
A CITATION.cff file MUST contain at least one author.
#CitationCff
warn
cff-doi-recommended
A CITATION.cff file SHOULD declare a DOI for citable releases.
#CitationCff
warn
cff-version-recommended
A CITATION.cff file SHOULD declare a software version.
#CitationCff
warn
cff-date-released-recommended
A CITATION.cff file SHOULD declare a date-released.
#CitationCff
warn
cff-license-recommended
A CITATION.cff file SHOULD declare an SPDX license identifier.
#CitationCff
warn
cff-repository-recommended
A CITATION.cff file SHOULD declare a repository-code URL.
#CitationCff