-
Notifications
You must be signed in to change notification settings - Fork 496
Added sponsorship feature to nuget.org documentation #3489
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
Changes from 1 commit
c887fce
39d2396
2d3240e
6029294
3d42cdd
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,120 @@ | ||||||
| --- | ||||||
| title: Package sponsorship on NuGet.org | ||||||
| description: Learn how to add sponsorship links to your NuGet packages and support package maintainers through NuGet.org's sponsorship feature. | ||||||
| author: pranathibora14 | ||||||
| ms.author: prabora | ||||||
| ms.date: 10/15/2025 | ||||||
| ms.topic: conceptual | ||||||
| ai-usage: ai-generated | ||||||
| --- | ||||||
|
|
||||||
| # Package sponsorship on NuGet.org | ||||||
|
|
||||||
| Package maintainers are the foundation of the NuGet.org ecosystem, building and maintaining the packages that developers rely on. The NuGet.org sponsorship feature makes it easier for package consumers to recognize and support the authors behind their favorite packages. | ||||||
|
|
||||||
| ## Overview | ||||||
pranathibora14 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| NuGet.org now allows package authors to add a sponsorship URL to their packages. This link appears as a heart icon or "Sponsor this package" button on the package's page, guiding users to secure and popular platforms like GitHub Sponsors, Patreon, and Open Collective. | ||||||
|
|
||||||
| For package consumers, supporting your favorite packages is now easier than ever. Look for the sponsor icon on NuGet.org to see which packages need support while browsing or managing dependencies. | ||||||
|
|
||||||
| ## Setting up sponsorship for package publishers | ||||||
|
|
||||||
| ### Prerequisites | ||||||
|
|
||||||
| - You must be the owner or co-owner of a package on NuGet.org | ||||||
| - Your sponsorship link platform must be from the approved list: | ||||||
| - GitHub Sponsors | ||||||
| - Patreon | ||||||
| - Open Collective | ||||||
| - Ko-fi | ||||||
| - Tidelift | ||||||
| - Liberapay | ||||||
|
|
||||||
| ### Navigate to your package management page | ||||||
|
|
||||||
| 1. Go to [NuGet.org](https://nuget.org) and sign in to your account. | ||||||
| 2. Select your username in the top right corner. | ||||||
| 3. Select **Manage Packages** from the dropdown menu. | ||||||
| 4. Find the package you want to add sponsorship information to and select the edit button. | ||||||
|
|
||||||
| ### Access sponsorship settings | ||||||
|
|
||||||
| 1. On your package management page, scroll down to find the **Sponsorship Links** section. | ||||||
| 2. Select to expand the collapsible **Sponsorship Links** section. | ||||||
| 3. You'll see a form where you can add sponsorship URLs. | ||||||
|
|
||||||
|  | ||||||
pranathibora14 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ### Add your sponsorship URLs | ||||||
|
|
||||||
| 1. Enter your sponsorship URL in the text field: | ||||||
| - Example: `https://github.com/sponsors/yourusername` | ||||||
| - Example: `https://www.patreon.com/yourusername` | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| 2. Select the **Add** button. | ||||||
| 3. The system automatically validates that your URL is from an approved platform. | ||||||
| 4. If any URLs are invalid or from non-approved platforms, you'll see error messages to correct them. Otherwise, you'll see a confirmation message that your sponsorship link has been saved. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| 5. Each added sponsorship URL will have a **Remove** button next to it if you need to delete it. | ||||||
| 6. You can add up to 10 different sponsorship URLs per package ID. | ||||||
|
|
||||||
| ### Verify your sponsorship URLs display correctly | ||||||
|
|
||||||
| 1. Navigate to your package's public page on NuGet.org. | ||||||
| 2. Look for the **Sponsor** button in the package details **About** section. | ||||||
| 3. Select the **Sponsor** button to test that your URLs appear correctly in the popup. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| ## Finding and supporting packages | ||||||
|
|
||||||
| ### Identify packages that need sponsorship | ||||||
|
|
||||||
| 1. Browse to any package page on NuGet.org. | ||||||
| 2. Look for packages displaying a **Sponsor** button in the package details section. | ||||||
| 3. The **Sponsor** button indicates that the package maintainer is seeking financial support. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| ### View available sponsorship options | ||||||
|
|
||||||
| 1. Select the **Sponsor** button on the package page. | ||||||
| 2. A popup window appears showing all available sponsorship links for that package. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| ### Choose your preferred sponsorship platform | ||||||
|
|
||||||
| 1. Review the available sponsorship options in the popup. | ||||||
| 2. Select your preferred platform to be redirected to the external sponsorship page. | ||||||
| 3. The link opens in a new tab or window, keeping the NuGet package page open. | ||||||
|
|
||||||
| > [!IMPORTANT] | ||||||
| > These links take you to third-party platforms. Microsoft isn't affiliated with or responsible for the content or practices of third-party platforms. | ||||||
|
||||||
| > These links take you to third-party platforms. Microsoft isn't affiliated with or responsible for the content or practices of third-party platforms. | |
| > These links take you to third-party platforms. Microsoft isn't affiliated with or responsible for the content or practices of third-party platforms, and we don't endorse them. |
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.
Probably, we should consider stating that we reserve the right to remove any third party if they are deemed unsafe, as companies may change ownership or their practices over time.
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.
+1. I'd suggest adding the following to continue with the release of the docs and then running the text by Eric Caldwell for CELA input. (On purpose keeping open ended instead of limiting ourselves to security as the reason to give us more discretion)
These links take you to third-party platforms. Microsoft isn't affiliated with or responsible for the content or practices of third-party platforms, and we don't endorse them. Microsoft reserves the right to remove any allowed third-party platforms.
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.
Thanks for your input @seaniyer. I'll make the change and follow up with Erin.
Uh oh!
There was an error while loading. Please reload this page.