Skip to content

chore: Include a README in the NuGet packages - #485

Open
ump45nose wants to merge 1 commit into
apache:mainfrom
ump45nose:chore/45-nuget-readme
Open

ump45nose wants to merge 1 commit into
apache:mainfrom
ump45nose:chore/45-nuget-readme

Conversation

@ump45nose

Copy link
Copy Markdown
Contributor

What's Changed

dotnet nuget push warns that our packages have no readme. This adds a short package readme (src/README.md) and wires it up in the shared NuGet properties in Directory.Build.props (PackageReadmeFile plus a packed Content item next to the license and icon), so every packable project under src/ gets it.

The root README.md is aimed at people building the repo (build steps, relative links to source folders), so I wrote a separate, smaller one for nuget.org: what Apache Arrow is, the list of packages, a short IPC reading example and links to the docs and the repository. All links are absolute so they work on nuget.org. It carries the usual ASF license header like the other Markdown files.

Checked with dotnet pack -c Release for each project in src/: all seven .nupkg files now contain README.md at the package root and their nuspec has <readme>README.md</readme>, with no new pack warnings.

This PR was prepared with AI assistance and reviewed by me.

Closes #45.

@adamreeve adamreeve left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for addressing this @ump45nose

Comment thread src/README.md
using Apache.Arrow;
using Apache.Arrow.Ipc;

public static async Task<RecordBatch> ReadArrowAsync(string filename)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can you please add a short description of what this example does. Eg. "Example of reading an Arrow IPC file".

Also, this example only reads the first batch of data from the file. It could mislead people if they copy this code, thinking it will read a whole file. Maybe it should return a List<RecordBatch> instead?

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

NuGet packages miss README

2 participants