Best practices using metadata

From Software Heritage Wiki
Revision as of 14:19, 15 May 2017 by Morane (talk | contribs)
Jump to: navigation, search

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

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

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