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

Mention the Open Source License in the README and/or documentation. #1317

Open
Ly0n opened this issue Jan 21, 2025 · 2 comments
Open

Mention the Open Source License in the README and/or documentation. #1317

Ly0n opened this issue Jan 21, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed high priority

Comments

@Ly0n
Copy link
Contributor

Ly0n commented Jan 21, 2025

Describe the feature you'd like to see

Hi PyPSA-Earth community,
If you read the README and/or the documentation, you might think that PyPSA-Earth is not an Open Source project, because the LICENSE is not automatically detected by GitHub. Also, there is no licence mentioned in the README. This might lead some people to think that the project is just 'open code' and not open source when looking on the documentation or README. So I would recommend adding a small note in the README in the form of a badge or a small section linking to the licence. Ideally, a LICENSE file should be automatically recognised by GitHub (this is the case when the LICENSE logo appears on the right-hand side), but this is a problem if you are using REUSE and multiple licenses. Many GitHub user have already complained about this. See the last comments here: todogroup/gh-issues#72

Maybe a small note to the README might help here like this:

``
This repository uses multiple licenses:

  1. LICENSES/AGPL-3.0-or-later
    See LICENSES/AGPL-3.0-or-later.txt for details.

  2. CC-BY-4.0 License
    See LICENSES/CC-BY-4.0 for details.

  3. CC0-1.0.txt
    See LICENSES/CC0-1.0.txt for details.

Refer to the individual files in the LICENSES directory for the full license texts.
``

@ekatef ekatef added help wanted Extra attention is needed good first issue Good for newcomers documentation Improvements or additions to documentation high priority and removed good first issue Good for newcomers labels Feb 5, 2025
@ekatef
Copy link
Member

ekatef commented Feb 5, 2025

Hey @Ly0n, completely agree and thanks a lot for pointing this out!

Apologies for a delay with the response: I just have hoped to answer suggesting a fix but it has not yet been feasible. Adding tags to the issue to keep it in sight

@ekatef
Copy link
Member

ekatef commented Feb 5, 2025

@GbotemiB may it be a good idea to add this work to the plan on documentation improvements?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed high priority
Projects
None yet
Development

No branches or pull requests

2 participants