From 7a3de1e15b0dc24e62fb175c5738079e6eab174c Mon Sep 17 00:00:00 2001 From: James Newton-King Date: Mon, 19 Nov 2018 13:56:57 +1300 Subject: [PATCH 1/2] Replace licenseUrl with license in recommended NuGet metadata --- docs/standard/library-guidance/nuget.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/docs/standard/library-guidance/nuget.md b/docs/standard/library-guidance/nuget.md index a53aac87a169e..8477c2aa58d85 100644 --- a/docs/standard/library-guidance/nuget.md +++ b/docs/standard/library-guidance/nuget.md @@ -38,7 +38,7 @@ NuGet package dependencies are covered in detail in the [Dependencies](./depende ## Important NuGet package metadata -A NuGet package supports many [metadata properties](/nuget/reference/nuspec). The following table contains the core metadata that every open-source project should provide: +A NuGet package supports many [metadata properties](/nuget/reference/nuspec). The following table contains the core metadata that every package on NuGet.org should provide: | MSBuild Property name | Nuspec name | Description | | ---------------------------------- | ------------------------ | ------------ | @@ -50,14 +50,12 @@ A NuGet package supports many [metadata properties](/nuget/reference/nuspec). Th | `PackageTags` | `tags` | A space-delimited list of tags and keywords that describe the package. Tags are used when searching for packages. | | `PackageIconUrl` | `iconUrl` | A URL for an image to use as the icon for the package. URL should be HTTPS and the image should be 64x64 and have a transparent background. | | `PackageProjectUrl` | `projectUrl` | A URL for the project homepage or source repository. | -| `PackageLicenseUrl` | `licenseUrl` | A URL to the project license. Can be the URL to the `LICENSE` file in source control. | - -**✔️ CONSIDER** choosing a NuGet package name with a prefix that meets NuGet's prefix reservation [criteria](/nuget/reference/id-prefix-reservation). - -**✔️ CONSIDER** using the `LICENSE` file in source control as the `LicenseUrl`. For example, [LICENSE.md](https://github.com/JamesNK/Newtonsoft.Json/blob/c4af75c8e91ca0d75aa6c335e8c106780c4f7712/LICENSE.md). +| `PackageLicenseExpression` | `license` | The project license's [SPDX identifier](https://spdx.org/licenses/). Only OSI and FSF approved licenses can use an expression. Other licenses should use `PackageLicenseFile`. Read more about [license metadata](/nuget/reference/nuspec#license). | > [!IMPORTANT] -> A project without a license defaults to [exclusive copyright](https://choosealicense.com/no-permission/), making it impossible for other people to use. +> A project without a license defaults to [exclusive copyright](https://choosealicense.com/no-permission/), making it legally impossible for other people to use. + +**✔️ CONSIDER** choosing a NuGet package name with a prefix that meets NuGet's prefix reservation [criteria](/nuget/reference/id-prefix-reservation). **✔️ DO** use an HTTPS href to your package icon. @@ -67,9 +65,7 @@ A NuGet package supports many [metadata properties](/nuget/reference/nuspec). Th **✔️ CONSIDER** setting up [SourceLink](./sourcelink.md) to add source control metadata to your assemblies and NuGet package. -> SourceLink automatically adds `RepositoryUrl` and `RepositoryType` metadata to the NuGet package. -> SourceLink also adds information about the exact source code the package was built from. -> For example, a package created from a Git repository will have the commit hash added as metadata. +> SourceLink automatically adds `RepositoryUrl` and `RepositoryType` metadata to the NuGet package. SourceLink also adds information about the exact source code the package was built from. For example, a package created from a Git repository will have the commit hash added as metadata. ## Pre-release packages From 86864c0625d76f1f482cb40ae0db667c105b1c8e Mon Sep 17 00:00:00 2001 From: James Newton-King Date: Mon, 19 Nov 2018 14:27:35 +1300 Subject: [PATCH 2/2] Minor update --- docs/standard/library-guidance/nuget.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/standard/library-guidance/nuget.md b/docs/standard/library-guidance/nuget.md index 8477c2aa58d85..c0685fc0e8340 100644 --- a/docs/standard/library-guidance/nuget.md +++ b/docs/standard/library-guidance/nuget.md @@ -50,7 +50,7 @@ A NuGet package supports many [metadata properties](/nuget/reference/nuspec). Th | `PackageTags` | `tags` | A space-delimited list of tags and keywords that describe the package. Tags are used when searching for packages. | | `PackageIconUrl` | `iconUrl` | A URL for an image to use as the icon for the package. URL should be HTTPS and the image should be 64x64 and have a transparent background. | | `PackageProjectUrl` | `projectUrl` | A URL for the project homepage or source repository. | -| `PackageLicenseExpression` | `license` | The project license's [SPDX identifier](https://spdx.org/licenses/). Only OSI and FSF approved licenses can use an expression. Other licenses should use `PackageLicenseFile`. Read more about [license metadata](/nuget/reference/nuspec#license). | +| `PackageLicenseExpression` | `license` | The project license's [SPDX identifier](https://spdx.org/licenses/). Only OSI and FSF approved licenses can use an identifier. Other licenses should use `PackageLicenseFile`. Read more about [`license` metadata](/nuget/reference/nuspec#license). | > [!IMPORTANT] > A project without a license defaults to [exclusive copyright](https://choosealicense.com/no-permission/), making it legally impossible for other people to use.