Best practices using metadata

From Software Heritage Wiki
Revision as of 23:41, 18 June 2017 by Morane (talk | contribs)
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.


1. Use a detailed metadata file with name appropriate to context as listed bellow :

context filename in CodeMeta crosswalk table implemented for swh translation
java- Maven pom.xml yes no
Octave DESCRIPTION yes no
R package DESCRIPTION yes no
ruby gems .gemspec or Rakefile yes no
Javascript npm package.json, [ AUTHORS, README, CHANGES, LICENSE & NOTICE] files yes no
Perl CPAN::META META.json, META.yml, .sDpec yes no
Dart pubspec.yaml no no
Debian package debian/upstream/metadata yes no
puppet metadata.json no no
PyPI setup.py yes no
Scientific software CITATION no no
CodeMeta CODE, code.json, codemeta.json yes no
Java gradle gradle.properties no no
Jekyll _config.yml no no
clojure project.clj or build.boot no no
haskell <project name>.cabal no no
scala build.sbt no no
Ocaml opam no no

2. Use Semantic Versioning [1] for reproducibility purposes.