DOIs and RepositoriesDOIsRepositories


  • DOIs are persistent identifiers that should always point to your code.
  • They should be maintained by the minting organisation, making them stronger than a URL.
  • DOIs can handle multiple versions of the same object.
  • Some repositories mint DOIs for deposits.
  • There are numerous repositories available and you should consider what you want from one
  • Some are better than others depending on your purpose and needs
  • GitHub doesn’t mint DOIs, but you can link your GitHub repos to a repository that does

Metadata and CitationMetadataCitation


  • Metadata helps drive discovery of your software
  • It’s easy to not include key elements as these are ‘obvious’
  • Standardisation of metadata is useful to help tools use the metadata
  • Citation is important to ensure that the correct recognition and credit is assigned to all work
  • Citation of software differs from that of articles, but is needed to aid the reproducibility of work
  • CITATION.cff files should contain all the necessary metadata and help create citations for use.
  • You may need to complete the relevant fields in multiple places to ensure correct citation in all cases.