Best practices using metadata
Jump to navigation
Jump to 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 |
| Octave | 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.