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

Fill copyright field in .csproj files to ensure that nuget packages will have both license and copyright fields filled #91144

Conversation

Konstantin-Kretov
Copy link
Contributor

Since Godot uses the MIT license, copyright is important for the correct display of license information.
This pull request adds the copyright to the csproj files, from where it will then go into NuGet packages.
The value from the LICENSE.txt file in the root of the repository was used as the copyright:

Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md).
Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.

@Konstantin-Kretov Konstantin-Kretov requested a review from a team as a code owner April 25, 2024 09:18
Copy link
Member

@akien-mga akien-mga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me from a copyright/license point of view.
No idea about the .NET ecosystem integration, I'll let the team assess.

@@ -14,6 +14,8 @@
<PackageType>MSBuildSdk</PackageType>
<PackageTags>MSBuildSdk</PackageTags>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<Copyright>Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since I assume AUTHORS.md won't be shipped together with the nuget package, I think we can change it to just:

Suggested change
<Copyright>Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md).
<Copyright>Copyright (c) 2014-present Godot Engine contributors.

That's what we do e.g. for in-engine copyright statements.

@raulsntos
Copy link
Member

Makes sense to me although I'm not sure how I feel about using multiple-lines. Microsoft's documentation recommends the format Copyright (c) <name/company> <year>. although they don't seem to follow this format in their own packages:

https://github.com/dotnet/arcade/blob/d54f6057363b8b249be56dcf8b91aa847f97a904/src/Microsoft.DotNet.Arcade.Sdk/tools/ProjectDefaults.props#L11-L12

@akien-mga How about just including Copyright (c) Godot Engine contributors to keep it short and a single line?

@akien-mga
Copy link
Member

How about just including Copyright (c) Godot Engine contributors to keep it short and a single line?

Sounds good to me.

@Konstantin-Kretov
Copy link
Contributor Author

@raulsntos I am not sure if we should remove personal mentions of the 2007-2014 contributors.
If you want to have a single line copyright, I would suggest:
Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur, 2014-present Godot Engine contributors.

@akien-mga
Copy link
Member

akien-mga commented Apr 26, 2024

Technically there's not much code from Juan and Ariel in the GodotSharp packages, so it's fine to just make it a blanket statement for all contributors.

Note: I'm the main "copyright" guy so you can trust my decision on that ;) Juan and Ariel won't feel left out.

@Konstantin-Kretov
Copy link
Contributor Author

@akien-mga So, the final decision is Copyright (c) Godot Engine contributors right?

@Konstantin-Kretov
Copy link
Contributor Author

@akien-mga I have just updated the files as we agreed.

@akien-mga
Copy link
Member

Looks good! Could you squash the commits? See PR workflow for instructions.

@Konstantin-Kretov Konstantin-Kretov force-pushed the k.kretov/add_copyright_to_csproj_files branch from 06f7edc to fc107ac Compare April 26, 2024 09:24
@Konstantin-Kretov
Copy link
Contributor Author

Done

@akien-mga
Copy link
Member

akien-mga commented Apr 26, 2024

Last nitpick, could you amend the commit message to be more like this:

Fill copyright field in .csproj files

This ensures that nuget packages will have both license and copyright fields filled.

It's best not to put user mentions in commits, as this generates a notification every time you or someone else re-pushes this commit, amended or as is.

Commit messages should also have a short title, otherwise it gets truncated and wrapped into a "more" field, as seen here:
image

This ensures that nuget packages will have both license and copyright fields filled.
@Konstantin-Kretov Konstantin-Kretov force-pushed the k.kretov/add_copyright_to_csproj_files branch from fc107ac to 2b46e00 Compare April 26, 2024 09:41
@Konstantin-Kretov
Copy link
Contributor Author

Done. I'm sorry to bother you so much.

@akien-mga
Copy link
Member

No worry! We're somewhat opinionated around the Git history in the Godot repo :D

@akien-mga akien-mga merged commit 38d2928 into godotengine:master Apr 26, 2024
16 checks passed
@akien-mga
Copy link
Member

akien-mga commented Apr 26, 2024

Thanks! And congrats for your first merged Godot contribution 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants