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 readme template #3299

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add readme template #3299

wants to merge 2 commits into from

Conversation

lyndaidaii
Copy link
Contributor

remove readme template to NuGet repo. easy to track.

@lyndaidaii lyndaidaii requested review from a team as code owners May 21, 2024 21:53
Copy link

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:

Copy link
Member

@nkolev92 nkolev92 left a comment

Choose a reason for hiding this comment

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

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
Copy link
Contributor Author

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
Copy link
Member

nkolev92 commented May 28, 2024

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

it's meant for code samples.

@lyndaidaii
Copy link
Contributor Author

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
Copy link
Contributor

JonDouglas commented May 29, 2024

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
Copy link
Member

zivkan commented Jul 23, 2024

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

@lyndaidaii lyndaidaii requested a review from a team as a code owner October 2, 2024 23:39
Copy link

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:

@lyndaidaii
Copy link
Contributor Author

Addressed comments. Please help take another look. Thanks.

@aortiz-msft aortiz-msft requested a review from nkolev92 October 2, 2024 23:42
Copy link
Member

@nkolev92 nkolev92 left a comment

Choose a reason for hiding this comment

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

A small wording suggestion.

@@ -27,6 +27,39 @@ Consider including the following items in your readme:
* Where and how to leave feedback such as link to the project issues, Twitter, bug tracker, or other platform.
* How to contribute, if applicable.

For example, package README template looks like this:
Copy link
Member

Choose a reason for hiding this comment

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

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


## Additional documentation

Provide links to more resources: List links such as detailed documentation, tutorial videos, blog posts, or any other relevant documentation to help users get the most out of your package.
Copy link
Contributor

Choose a reason for hiding this comment

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

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?

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.

5 participants