Maintainer's Guide

This page acts as a guide for maintainers and provides a space to collect development practices and 'collective wisdom' e.g. checklists for releases, GitHub repo maintainence, and other practices that are the responsibility of maintainers and are distinct from development concerns (e.g. style choices, grammatical preferences).

New Version Checklist

TODO

• Diagrams: Update version number in diagrams and diagram captions
• README: Update the version number in relevant places, including:
  • The IRI at:

    The versionless base IRI, e.g. https://w3id.org/dpv, always points to the latest release which is a versioned IRI, e.g. https://w3id.org/dpv/X.Y for vX.Y.

  • The "Final Reports" section:

    Below are reports corresponding to the latest release vX.Y.

Release Checklist

TODO

• w3id.org redirections
• Release notes
  • Breaking changes and deprecation
• Diagrams
  • Recheck version number in diagrams
  • Recheck version number in diagram captions
• Contributor list
  • Recheck preferred names and spelling of names
  • Recheck affiliations if it is up-to-date
• README
  • Check version number in IRIs points to latest version
  • Recheck the "Funding Acknowledgements" if it is up-to-date
• homepage (index.html) and 404
  • Check each links in the page, each should bring to an intended location, no deadlink
• Make default version to the latest version
  • Redirect https://w3id.org/dpv/ to the latest version
  • Update master branch with content from dev branch
• Make previous version "outdated"
  • Put "This version is outdated, see latest published version." footer to previous version