Skip to content

SPDX license identifiers #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 7, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions _extras/recommended-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,18 @@ Below are a set of recommended good practices to keep in mind when writing a Com

☐ No `type: string` parameters for names of input or reference files/directories; use `type: File` or `type: Directory` as appropriate.

☐ Include a license that allows for re-use by anyone, e.g. [Apache 2.0][apache-license]. [Example of license inclusion][license-example].
☐ Include a license that allows for re-use by anyone, e.g. [Apache 2.0][apache-license]. If possible, the license should be specified with its corresponding [SPDX identifier][spdx]. Construct the metadata field for the licence by providing a URL of the form `https://spdx.org/licenses/[SPDX-ID]` where `SPDX-ID` is the taken from the list of identifiers linked above. See the example snippet below for guidance. For non-standard licenses without an SPDX identifier, provide a URL to the license.

_Example of metadata field for license with SPDX identifier:_
~~~
$namespaces:
s: http://schema.org/
s:license: https://spdx.org/licenses/Apache-2.0
# other s: declarations
~~~
{: .source}

For more examples of providing metadata within CWL descriptions, see the [Metadata and Authorship section][metadata-lesson] of this User Guide.

☐ Include [attribution information][license-example] for the author(s) of the CWL tool or workflow description. Use unambiguous identifiers like [ORCID][orcid].

Expand Down Expand Up @@ -40,11 +51,12 @@ Below are a set of recommended good practices to keep in mind when writing a Com

☐ Complex workflows with individual components which can be abstracted should utilise the [`SubworkflowFeatureRequirement`][subworkflow] to make their workflow modular and allow sections of them to be easily reused.

[apache-license]: https://www.apache.org/licenses/LICENSE-2.0#apply
[apache-license]: https://spdx.org/licenses/Apache-2.0.html
[license-example]: https://github.com/ProteinsWebTeam/ebi-metagenomics-cwl/blob/master/workflows/emg-assembly.cwl#L200
[scicrunch-issue]: https://github.com/common-workflow-language/common-workflow-language/issues/scicrunch.org
[edam-example]: http://edamontology.org/format_1915
[iana-types]: http://www.iana.org/assignments/media-types/media-types.xhtml
[file-prop]: http://www.commonwl.org/v1.0/CommandLineTool.html#File
[orcid]: https://orcid.org
[subworkflow]: http://www.commonwl.org/v1.0/Workflow.html#SubworkflowFeatureRequirement
[metadata-lesson]: /user_guide/17-metadata/
2 changes: 1 addition & 1 deletion _includes/cwl/17-metadata/metadata_example2.cwl
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ s:contributor:
s:citation: https://dx.doi.org/10.6084/m9.figshare.3115156.v2
s:codeRepository: https://github.com/common-workflow-language/common-workflow-language
s:dateCreated: "2016-12-13"
s:license: https://www.apache.org/licenses/LICENSE-2.0
s:license: https://spdx.org/licenses/Apache-2.0

$namespaces:
s: https://schema.org/
Expand Down
2 changes: 1 addition & 1 deletion _includes/cwl/17-metadata/metadata_example3.cwl
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ s:contributor:
s:citation: https://dx.doi.org/10.6084/m9.figshare.3115156.v2
s:codeRepository: https://github.com/common-workflow-language/common-workflow-language
s:dateCreated: "2016-12-13"
s:license: https://www.apache.org/licenses/LICENSE-2.0
s:license: https://spdx.org/licenses/Apache-2.0

s:keywords: edam:topic_0091 , edam:topic_0622
s:programmingLanguage: C
Expand Down