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

Add a README in nuspec #1377

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

WanjohiSammy
Copy link
Contributor

Issues

This pull request fixes #xxx.

Description

This PR

  • add README files for Microsoft.AspNetCore.OData NuGet
  • update nuspec files to add readme element. This is to ensure README.md is package when generating NuGet package.

README.md files added:

Checklist (Uncheck if it is not completed)

  • Test cases added
  • Build and test with one-click build and test script passed

Additional work necessary

If documentation update is needed, please add "Docs Needed" label to the issue and provide details about the required document change in the issue.

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 4 changed files in this pull request and generated no comments.

Files not reviewed (3)
  • src/Microsoft.AspNetCore.OData.Nightly.nuspec: Language not supported
  • src/Microsoft.AspNetCore.OData.Release.nuspec: Language not supported
  • src/Microsoft.AspNetCore.OData/Microsoft.AspNetCore.OData.csproj: Language not supported
@WanjohiSammy WanjohiSammy changed the title Add readme path from cproj and add it in nuspec Add a README in nuspec Dec 18, 2024
@@ -29,5 +30,8 @@
<file src="$ProductRoot$\net8.0\Microsoft.AspNetCore.OData.xml" target="lib\net8.0" />
<file src="$ProductRoot$\net8.0\Microsoft.AspNetCore.OData.pdb" target="lib\net8.0" />
<file src="$SourcesRoot$\images\odata.png" target="images\" />

<!-- readme file -->
<file src="$SourcesRoot$\src\Microsoft.AspNetCore.OData\Docs\README.md" target="docs\" />
Copy link
Member

Choose a reason for hiding this comment

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

just put on the root ?

@@ -0,0 +1,213 @@
# Microsoft.AspNetCore.OData
Copy link
Member

Choose a reason for hiding this comment

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

can we use the existed readme.md file on the root? avoid creating a new / duplicated file?

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.

2 participants