nixxcode / jvm-brotli

Lightweight, cross-platform Java library for the Brotli compression format
73 stars 10 forks source link

Unclear Licensing #44

Open joakime opened 2 years ago

joakime commented 2 years ago

This project has unclear licensing.

You have mention the licensing of other code in your README.

But you haven't properly declared a license for your project.

I see you have a <licenses> section in your pom.xml, which is a good first step.

But most projects that care about licensing (like Eclipse Foundation or Apache Foundation), require a few more things.

Create license file in your project root on github (names like LICENSE, or LICENSE.txt, or LICENSE.md are common). This should contain the license (or licenses if multi-licensed) for your project.

Then create a notice file in your project root on github (names like NOTICE, or NOTICE.txt, or NOTICE.md are common) This is used to indicate licensed content that you are using, just like you have defined in your README.

Bonus, is that these 2 files are also used by github and your project will start advertising their license properly in the github metadata.

Finally, those 2 files should be present in your binary artifacts as well. Usually in the META-INF/ directory.

One tip, use the SPDX-License-Identifier: at the end of your LICENSE file correctly, and you'll get even better license integration across the various tooling out in the wild. See https://spdx.org/licenses/