Skip to content
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

Add 3rd party licenses and bump version to 1.0.0 #208

Merged
merged 2 commits into from
Dec 2, 2024

Conversation

hoangtungdinh
Copy link
Collaborator

Description

This PR adds 3rd party licenses and updates the version to 1.0.0

How was the PR tested?

  1. Test with CI/CD

Notes

Related issue: #207

@AsamDiegoSanchez
Copy link
Member

I was reviewing it, and maybe it is because I do not know them, but I think we need to input a short description of the 3rd dependencies, i.e "Black_LICENSE", what is it or what is this for? and link it to the file or source code where it is use... Similar to what we did already here: https://github.com/asam-ev/qc-framework/blob/main/licenses/readme.md

@andreaskern74
Copy link
Collaborator

andreaskern74 commented Nov 28, 2024

I was reviewing it, and maybe it is because I do not know them, but I think we need to input a short description of the 3rd dependencies, i.e "Black_LICENSE", what is it or what is this for? and link it to the file or source code where it is use... Similar to what we did already here: https://github.com/asam-ev/qc-framework/blob/main/licenses/readme.md

I've also thought about that topic.... in the mentioned existing file we added "non-standard" information:

  • GoogleTest: "only used for build/testing, not integrated"
  • Qt: The added information is important, because Qt is super big. And some modules are "not allowed" to use in Open Source software. So the info is that we use Qt, but only the allowed modules of it.
  • Xerces-C++: no additional info.... this is how the PR from @hoangtungdinh looks like

The bottom line is that it might be meaningful to add information

  • which parts are used "only" for CI, testing, ... --> typically on GitHub or if a user adapts it in his internal environment
  • which 3rd parties are used during installation or during runtime of the product, used by the final user of the framework

Because these two use cases might make a difference when people talk to legal. Didn't see any critical things... all are standard Open Source components, which are used everywhere.

If we want to be really good, that one sentence might be interesting for what/why we use it. This might help in understanding why we did not want to implement everything from scratch. A description of the 3rd party dep is not necessary IMHO, because it is public available, PyPI homepage could be linked for example. Then it's also clear that this comes via PIP and not necessary to download a source code.

This whole topic is difficult, because there is always somebody who needs more information 🤣

@hoangtungdinh
Copy link
Collaborator Author

Hi @AsamDiegoSanchez @andreaskern74 . I added a short description for each dependency (just how it is used in our codebase) and links to them on PyPi server, where they are downloaded. I will also do that for other repos.

@hoangtungdinh hoangtungdinh force-pushed the ivex/tung/license-and-version-bump branch from 2b405b8 to 62a77e3 Compare November 29, 2024 10:30
@andreaskern74
Copy link
Collaborator

Hi @AsamDiegoSanchez @andreaskern74 . I added a short description for each dependency (just how it is used in our codebase) and links to them on PyPi server, where they are downloaded. I will also do that for other repos.

@hoangtungdinh : Looks really good!

@AsamDiegoSanchez
Copy link
Member

Thanks @hoangtungdinh! Yes, I think it is much clear now. @andreaskern74 if you also agree, we can tag it as ready "ForCCBReview". I will also add @MatteoRagni and @pmai

@andreaskern74 andreaskern74 added the isState:ForCCBReview CCB will review it and change the status to ReadyForMerge if everything is ok label Nov 29, 2024
@andreaskern74 andreaskern74 merged commit b0067a9 into main Dec 2, 2024
4 checks passed
@andreaskern74 andreaskern74 deleted the ivex/tung/license-and-version-bump branch December 2, 2024 13:51
@andreaskern74
Copy link
Collaborator

Will be merged for releasing....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
isState:ForCCBReview CCB will review it and change the status to ReadyForMerge if everything is ok
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants