LightGBM icon indicating copy to clipboard operation
LightGBM copied to clipboard

NuGet package is missing README

Open jameslamb opened this issue 10 months ago • 3 comments

Description

While uploading the NuGet package at https://www.nuget.org/packages/LightGBM for v4.6.0, I saw the following warning:

We found the following issue(s) with the package. We recommend that you fix these issues and re-upload the package: Readme missing. See how to include a readme file within the package, or add it as you upload. To learn more about authoring great packages, view our Best Practices page.

It would be great to fix that for the next release, so a README could be rendered on that page.

Benefits of this work

Improves documentation, and might improve the search ranking of the NuGet package for those searching for that.

Acceptance criteria

  • .nupkg includes a README

Approach

Follow those links in the warning message, propose changes here.

Notes

We don't have much .NET experience on the maintainer team here, so this would not be a good issue for someone who needs a lot of guidance. This issue is ideal for someone who understands .NET packaging or is willing to teach themselves and then teach us 😊

jameslamb avatar Feb 15 '25 04:02 jameslamb

Sure, thanks! We'd welcome the help.

jameslamb avatar Jul 20 '25 18:07 jameslamb

Hi Can you assign me the issue.

Rocker810 avatar Oct 12 '25 00:10 Rocker810

@Rocker810 you are welcome to attempt a pull request, thanks for your interest! Please read https://github.com/microsoft/LightGBM/pull/6972#issuecomment-3094698794 first.

jameslamb avatar Oct 12 '25 06:10 jameslamb