Skip to content

Commit d0da16b

Browse files
mr-cKaushik Ghosekghosetobyhodgesstain
authored
expand latin; link to license advice (#120)
Co-authored-by: Michael R. Crusoe <[email protected]> Co-authored-by: Kaushik Ghose <[email protected]> Co-authored-by: Kaushik Ghose <[email protected]> Co-authored-by: tobyhodges <[email protected]> Co-authored-by: Stian Soiland-Reyes <[email protected]>
1 parent 3667195 commit d0da16b

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

src/topics/best-practices.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,23 @@ all are required.
88
- No `type: string` parameters for names of input or reference
99
files/directories; use `type: File` or `type: Directory` as appropriate.
1010

11-
- Include a license that allows for re-use by anyone, e.g.
12-
[Apache 2.0][apache-license]. If possible, the license should be specified with
13-
its corresponding [SPDX identifier][spdx]. Construct the metadata field for the
14-
licence by providing a URL of the form `https://spdx.org/licenses/[SPDX-ID]`
15-
where `SPDX-ID` is the taken from the list of identifiers linked above. See the
16-
example snippet below for guidance. For non-standard licenses without an SPDX
11+
- A CWL document (in conjunction with any external components like `Dockerfile`s) is software code.
12+
Workflow developers should be aware that the usual rules of software licensing apply to this
13+
document. For example if the workflow is shared publicly, licensing terms have to be clear so that
14+
a future user can understand under what conditions they can run the workflow, modify it and/or
15+
combine it with other workflows. For this reason please consider including a license field in the
16+
document. The authors of this guide urge you to choose a pre-existing license rather than trying
17+
to write your own (see the link below to learn more about choosing a license), and our recommended
18+
practice is to choose a license that allows for re-use by anyone, e.g. [Apache 2.0][apache-license].
19+
20+
If possible, the license should be specified wit its corresponding [SPDX identifier][spdx].
21+
Construct the metadata field for the licence by providing a URL of the form
22+
`https://spdx.org/licenses/[SPDX-ID]` where `SPDX-ID` is the taken from the list of identifiers
23+
linked above. See the example snippet below for guidance. For non-standard licenses without an SPDX
1724
identifier, provide a URL to the license.
1825

26+
Useful reading: "[A Quick Guide to Software Licensing for the Scientist-Programmer][sci-license]"
27+
1928
_Example of metadata field for license with SPDX identifier:_
2029

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

101111
% TODO
102112
%

0 commit comments

Comments
 (0)