Difference between revisions of "Best practices using metadata"

From Software Heritage Wiki
Jump to navigation Jump to search
(Created page with " 1. Use a detailed metadata file with name appropriate to context as listed bellow : {| class="wikitable sortable" |- !context !filename !implemented for swh translation |-...")
 
Line 13: Line 13:
 
|no
 
|no
 
|-
 
|-
|Octave
+
|Octave
 +
|DESCRIPTION
 +
|no
 +
|-
 +
|R package
 
|DESCRIPTION
 
|DESCRIPTION
 
|no
 
|no

Revision as of 14:19, 15 May 2017


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
Octave DESCRIPTION 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 setup.py no
Scientific software CITATION no
CodeMeta CODE, code.json no
Java gradle gradle.properties 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.