Skip to content

Made licensing guideline more neutral #120

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.

Sign up for GitHub

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 3 commits into from
Oct 13, 2022
Merged

Made licensing guideline more neutral #120

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a055aa9
expand latin; link to license advice
mr-c Jul 26, 2019
9332038
Merge remote-tracking branch 'origin/main' into kaushik-oct-2018
mr-c Oct 13, 2022
61a476d
Merge remote-tracking branch 'origin/main' into kaushik-oct-2018
mr-c Oct 13, 2022
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
22 changes: 16 additions & 6 deletions src/topics/best-practices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,23 @@ all are required.
- 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]. 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
- A CWL document (in conjunction with any external components like `Dockerfile`s) is software code.
Workflow developers should be aware that the usual rules of software licensing apply to this
document. For example if the workflow is shared publicly, licensing terms have to be clear so that
a future user can understand under what conditions they can run the workflow, modify it and/or
combine it with other workflows. For this reason please consider including a license field in the
document. The authors of this guide urge you to choose a pre-existing license rather than trying
to write your own (see the link below to learn more about choosing a license), and our recommended
practice is to choose a license that allows for re-use by anyone, e.g. [Apache 2.0][apache-license].

If possible, the license should be specified wit 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.

Useful reading: "[A Quick Guide to Software Licensing for the Scientist-Programmer][sci-license]"

_Example of metadata field for license with SPDX identifier:_

```cwl
Expand Down Expand Up @@ -97,6 +106,7 @@ all are required.
[orcid]: https://orcid.org
[subworkflow]: https://www.commonwl.org/v1.0/Workflow.html#SubworkflowFeatureRequirement
[spdx]: https://spdx.org/licenses/
[sci-license]: https://doi.org/10.1371/journal.pcbi.1002598

% TODO
%
Expand Down