-
Notifications
You must be signed in to change notification settings - Fork 488
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
base: main
Are you sure you want to change the base?
Add readme template #3299
Conversation
Learn Build status updates of commit 69f26cf:
|
File | Status | Preview URL | Details |
---|---|---|---|
docs/template/README.md | 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
There was a problem hiding this 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.
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. |
Should we use https://github.com/nuget/samples instead? it's meant for code samples. |
good idea, I will move it to Samples repo |
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. |
@lyndaidaii can you please update this PR, or provide us with a status update? |
Learn Build status updates of commit 4574a32: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Addressed comments. Please help take another look. Thanks. |
There was a problem hiding this 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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
There was a problem hiding this comment.
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?
remove readme template to NuGet repo. easy to track.