abpframework / abpframework/abp

Consider to add readme files to nuget packages

Open
#8,912 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

abp-framework documentation priority:low
Dominant language
C#
Stars
14.4k
Forks
3.7k
Avg merge
15h 32m
Merged PRs (30d)
106

Description

https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/

We can add a small info for each package (at least, to major feature packages), then forward to the related page in our documentation. If no direct document, we can just redirect to the home page of the documentation website.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review how this repository publishes its NuGet packages and identify the major feature packages covered by the request. Check the linked NuGet guidance and related documentation pages, then ensure each selected package has a small README linking to its documentation or the documentation home page.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.