Skip to content
Holds text specifications for CFF. Also the source for https://citation-file-format.github.io
CSS HTML JavaScript Python Ruby TeX Shell
Branch: src
Clone or download
jspaaks Merge pull request #12 from alex-konovalov/patch-1
Add a link to WSSSPE5.1 blogpost
Latest commit cb45a3a Mar 27, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
0.9-RC1
1.0-RC1
1.0.0
1.0.1
1.0.2
1.0.3
_bibliography
_data
_includes
_layouts
_sass
assets
events
template
.gitignore
.travis.yml
0.9-RC1.md
1.0-RC1-changes.md
1.0-RC1.md
1.0.0-changes.md
1.0.0.md
1.0.1-changes.md
1.0.1.md
1.0.2-changes.md
1.0.2.md
1.0.3-changes.md
1.0.3.md
Gemfile
README.md
Rakefile
_config.yml
build-pdfs.py
changes.sh
index.md
package.json
requirements.txt
staticman.yml
travis-build.sh
versions.md

README.md

DOI Build Status License: CC BY-SA 4.0

Citation File Format (CFF) Specifications

The format specifications for CFF are available online in HTML format and as a PDF.

citation-file-format.github.io

For general information (contributing, other repositories, etc.), please see https://github.com/citation-file-format/citation-file-format/blob/master/README.md.

This repository holds the website and specifications for CFF

Documentation is provided in the form of a Jekyll site hosted on GitHub pages (using https://mmistakes.github.io/minimal-mistakes/), and a PDF.

Versions

To work on a new version, create a branch from src with the version number, e.g., 0.9-RC1, create a directory named after the version, e.g., 0.9-RC1, and copy the specifications.md file from the last version into the directory.

Important: Do NOT rename the file, do NOT change the directory structure.

Specifications are only written in specifications.md in a version branch! The Markdown dialect is kramdown, and Jekyll specificities apply.

  • Don't forget to change the version tag in the YAML metadata at the start of specifications.md, and in the file contents!

Once a version is release-ready, do the following:

  • Change the release-date meta tag in the YAML frontmatter of specifications.md
  • Create a landing page {version}.md file for the version in the {version} folder, describing the version (including release notes, changes, etc.).
  • In _config.yml, set current to the version number, e.g., 0.9-RC1.
  • Add the version and a link to the respective schema release to the table in versions.md. Create a new version on Zenodo to reserve a DOI, add that DOI to the versions table.
  • Add the version in the PDF link for addition to GitHub release .travis.yml
  • Commit the changes
  • Run changes.sh to create a list of changes to display on the landing page
  • Merge the version branch to src and create a version tag.
  • Push src. Travis CI will pick up the pushed commit and build it. If you don't want your commits to be built automatically, add [skip ci] to your commit message.

Build

  • Push src to GitHub, Travis will take care of the rest

Post-release

  • Add the Zenodo DOI badge to the release that has been created by Travis.
You can’t perform that action at this time.