Skip to content

add PACKAGE.md for System.Formats.Nrbf #106344

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

Merged
merged 3 commits into from
Aug 14, 2024
Merged

Conversation

adamsitnik
Copy link
Member

@adamsitnik adamsitnik added documentation Documentation bug or enhancement, does not impact product or test code binaryformatter-migration Issues related to the removal of BinaryFormatter and migrations away from it labels Aug 13, 2024
@adamsitnik adamsitnik added this to the 9.0.0 milestone Aug 13, 2024
Copy link
Contributor

@terrajobst terrajobst left a comment

Choose a reason for hiding this comment

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

Left some feedback, but this looks great!

I assume PACKAGE.md is a magic name that nuget.org uses to render as the README?

@adamsitnik
Copy link
Member Author

I assume PACKAGE.md is a magic name that nuget.org uses to render as the README?

My understanding is that we don't use README.md name because we already had such files (they are often used for providing docs specific to our repo). I expect some magic MSBuild check like this one ensures that it works fine with NuGet:

<!-- PackageReadmeFile specifies the package readme file name in the package. PackageReadmeFilePath points to the package readme file on disk. -->
<PackageReadmeFile Condition="'$(PackageReadmeFile)' == '' and '$(EnableDefaultPackageReadmeFile)' == 'true'">PACKAGE.md</PackageReadmeFile>
<PackageReadmeFilePath Condition="'$(PackageReadmeFilePath)' == '' and '$(EnableDefaultPackageReadmeFile)' == 'true'">PACKAGE.md</PackageReadmeFilePath>

@adamsitnik adamsitnik merged commit 236538b into dotnet:main Aug 14, 2024
13 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Sep 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-System.Formats.Nrbf binaryformatter-migration Issues related to the removal of BinaryFormatter and migrations away from it documentation Documentation bug or enhancement, does not impact product or test code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

System.Formats.Nrbf lacks a package readme
2 participants