Skip to content

No license and copyright information in the files #1

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

Closed
OliverFendt opened this issue Oct 30, 2017 · 2 comments
Closed

No license and copyright information in the files #1

OliverFendt opened this issue Oct 30, 2017 · 2 comments
Assignees
Labels
documentation About end-user documentation

Comments

@OliverFendt
Copy link

Since this is an open Source compliance toolkit, I would love to see the best practises for a good OSS project realized in this project.
Some of the best practises are:

  1. Put a copyrihgt notice in each file
  2. Put the relevant Strandard License Header in file (or a statement like This file is licensed under --SPDX Short Identifier --

The FSFE hast set up a Project with best practizes relevant for smart license compliance support, the proejct is called reuse. Please see https://reuse.software/
No file of the current release carries a standarde license haeder, there is no license information in the files at all. The same applies to the copyright information, except the README.md file.

Regarding the README.md file, please remove the statement "See the LICENSE file in the root of this project for license details." because no license scanner can "auto conclude" such a statement.

The file oss-review-toolkit-preview/analyzer/src/funTest/assets/projects/synthetic/mixed/NPMNestedMaven/package.json
{
"name": "npmnestedmaven",
"version": "1.0.0",
"description": "A dummy NPM project with a nested Maven project",
"scripts": {
"test": "echo "Error: no test specified" && exit 1"
},
"author": "Sebastian Schuberth",
"license": "ISC",
"repository": {
"type": "git",
"url": "https://github.com/heremaps/oss-review-toolkit.git"
}
}
Carries a license information which doea not fit. Even in case of test files you should care for license hygiene

@sschuberth
Copy link
Member

Thanks for pointing out https://reuse.software/! We'll certainly follow best practices regarding copyright / license headers and test data once we publish the final history.

I believe we should keep the reference from README.md to LICENSE. This is a hint for humans only, as GitHub only shows the contents of README.md on the front page, but inlining LICENSE into README.md does not really make sense.

@sschuberth sschuberth self-assigned this Nov 3, 2017
sschuberth added a commit that referenced this issue Nov 6, 2017
Make it use Apache-2.0 like our real main project does.

See #1.

Change-Id: If3d99c821748aa9138286c0d0b9bddb37835a293
sschuberth added a commit that referenced this issue Nov 6, 2017
See #1.

Change-Id: I91eba2957f6f6578de2c8aeeffa83e6f2fd5cb91
@sschuberth
Copy link
Member

We just pushed the final history to the master branch which has the copyright / license headers added.

@sschuberth sschuberth added enhancement documentation About end-user documentation labels May 7, 2018
fviernau added a commit that referenced this issue Nov 27, 2023
The list licenses command may crash in case `sourceCodeDir` is not
provided in the following scenarios:

1. When the source artifact has been scanned for the given `packageId`
   andi `vcsProcessed` is empty, then `fetchScannedSources()` crashes
   withing `Downloader.download()`, because the downloader throws when
   it attempts to download from VCS.
2. When the ORT file does not contain any scan result for the given
   package, then the downloader also throws.

Ensure that the downloader always attempts to download from the right
source code origin, to fix scenario #1. Furthermore, return early in
case there is no scan result for the given package to fix scenario #2.
Recently a similar crash has been fixed by [1] also by returning
earlier. So, move the early return from [1] to an even earlier position.

[1] 5a21932

Signed-off-by: Frank Viernau <[email protected]>
fviernau added a commit that referenced this issue Nov 27, 2023
The list licenses command may crash in case `sourceCodeDir` is not
provided in the following scenarios:

1. When the source artifact has been scanned for the given `packageId`
   and `vcsProcessed` is empty, then `fetchScannedSources()` crashes
   withing `Downloader.download()`, because the downloader throws when
   it attempts to download from VCS.
2. When the ORT file does not contain any scan result for the given
   package, then the downloader also throws.

Ensure that the downloader always attempts to download from the right
source code origin, to fix scenario #1. Furthermore, return early in
case there is no scan result for the given package to fix scenario #2.
Recently a similar crash has been fixed by [1] also by returning
earlier. So, move the early return from [1] to an even earlier position.

[1] #7832

Signed-off-by: Frank Viernau <[email protected]>
fviernau added a commit that referenced this issue Nov 27, 2023
The list licenses command may crash in case `sourceCodeDir` is not
provided in the following scenarios:

1. When the source artifact has been scanned for the given `packageId`
   and `vcsProcessed` is empty, then `fetchScannedSources()` crashes
   withing `Downloader.download()`, because the downloader throws when
   it attempts to download from VCS.
2. When the ORT file does not contain any scan result for the given
   package, then the downloader also throws.

Ensure that the downloader always attempts to download from the right
source code origin, to fix scenario #1. Furthermore, return early in
case there is no scan result for the given package to fix scenario #2.
Recently a similar crash has been fixed by [1] also by returning
earlier. So, move the early return from [1] to an even earlier position.

[1]: #7832

Signed-off-by: Frank Viernau <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation About end-user documentation
Projects
None yet
Development

No branches or pull requests

2 participants