Add readme template

[lyndaidaii]

remove readme template to NuGet repo. easy to track.

[learn-build-service-prod]

Learn Build status updates of commit 69f26cf:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
docs/template/README.md	⚠️Warning	View	Details

docs/template/README.md

• Line 0, Column 0: [Warning: h1-missing - See documentation] H1 is required. Use a single hash (#) followed by a space to create your top-level heading.
• Line 1, Column 1: [Warning: title-missing - See documentation] Missing required attribute: 'title'. Add a title string to show in search engine results.
• Line 1, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

• Try searching the learn.microsoft.com contributor guides
• Post your question in the Learn support channel

[nkolev92]

I'm not sure I get this change in the context of the docs repo.

It's not really referenced anywhere, so it'd be just unreachable text.

[lyndaidaii]

I'm not sure I get this change in the context of the docs repo.

It's not really referenced anywhere, so it'd be just unreachable text.

this template used to exist in my personal repo, it will be better to move to this public repo, so that link will be valid. currently no intention to be publish on Microsoft document page.

[nkolev92]

Should we use https://github.com/nuget/samples instead?

it's meant for code samples.

[lyndaidaii]

Should we use https://github.com/nuget/samples instead?

it's meant for code samples.

good idea, I will move it to Samples repo

[JonDouglas]

I believe adding markdown to our docs was the ideal location. Just not as a markdown to our docs repo, rather a section in our documentation with the template! i.e.

https://learn.microsoft.com/en-us/nuget/nuget-org/package-readme-on-nuget-org#what-should-my-readme-include

[zivkan]

@lyndaidaii can you please update this PR, or provide us with a status update?

[learn-build-service-prod]

Learn Build status updates of commit 4574a32:

✅ Validation status: passed

File	Status	Preview URL	Details
docs/nuget-org/package-readme-on-nuget-org.md	✅Succeeded	View

For more details, please refer to the build report.

For any questions, please:

• Try searching the learn.microsoft.com contributor guides
• Post your question in the Learn support channel

[lyndaidaii]

Addressed comments. Please help take another look. Thanks.

[nkolev92]

A small wording suggestion.

[nkolev92]

Suggested change

	For example, package README template looks like this:
	For example, you can start with this package README template:

[erdembayar]

Based on the Moq incident, should the package owner declare if they have any privacy-related disclosure somewhere in the README file upfront if it really needs to send some information?