-
Notifications
You must be signed in to change notification settings - Fork 487
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
lyndaidaii
wants to merge
2
commits into
main
Choose a base branch
from
addTemplate
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add readme template #3299
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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: | ||
|
||
```text | ||
# Package readme title, e.g., display name or title of the package (optional) | ||
|
||
Start with a clear and concise description: A brief overview of what your package is and does, also what problem it solves. | ||
|
||
## Getting started | ||
|
||
Explain how to use your package, provide clear and concise getting started instructions, including any necessary steps. | ||
|
||
### Prerequisites | ||
|
||
What are specific minimum requirements to use your packages? Consider excluding this section if your package works without any additional setup beyond simple package installation. | ||
|
||
## Usage | ||
|
||
Examples about how to use your package by providing code snippets/example images, or samples links on GitHub if applicable. | ||
|
||
- Provide sample code using code snippets | ||
- Include screenshots, diagrams, or other visual help users better understand how to use your package | ||
|
||
## 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 commentThe 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? |
||
|
||
## Feedback | ||
|
||
Where and how users can leave feedback? | ||
|
||
- Links to a GitHub repository where could open issues, Twitter, a Discord channel, bug tracker, or other platforms where a package consumer can connect with the package author. | ||
``` | ||
|
||
Keep in mind, high quality readmes can come in a wide variety of formats, shapes, and sizes! If you already have a package available on NuGet.org, chances are that you already have a `readme.md` or other documentation file in your repository that would be a great addition to your NuGet.org details page. | ||
|
||
> [!Note] | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.