Skip to content

Commit 49e5e25

Browse files
Added sponsorship feature to nuget.org documentation (#3489)
* Added sponsorship feature to nuget.org documentation along with photos
1 parent 515396e commit 49e5e25

7 files changed

+119
-0
lines changed

docs/nuget-org/TOC.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
## [Package ID prefix reservation](id-prefix-reservation.md)
99
## [Package deprecation](deprecate-packages.md)
1010
## [Package readme](package-readme-on-nuget-org.md)
11+
## [Package sponsorship](package-sponsorship-on-nuget-org.md)
1112
# Policies
1213
## [Data Requests](policies/Data-requests.md)
1314
## [Dispute resolution](policies/dispute-resolution.md)
60.1 KB
Loading
157 KB
Loading
127 KB
Loading
73.9 KB
Loading
87.2 KB
Loading
Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
title: Package sponsorship on NuGet.org
3+
description: Learn how to add sponsorship links to your NuGet packages and support package maintainers through NuGet.org's sponsorship feature.
4+
author: pranathibora14
5+
ms.author: prabora
6+
ms.date: 10/15/2025
7+
ms.topic: conceptual
8+
ai-usage: ai-generated
9+
---
10+
11+
# Package sponsorship on NuGet.org
12+
13+
The NuGet.org sponsorship feature makes it easier for package consumers to recognize and support the authors behind their favorite packages.
14+
15+
NuGet.org enables package authors to add sponsorship URLs to their packages. These links appear when the "Sponsor" button on the package details page is selected.
16+
17+
18+
## Setting up sponsorship for package publishers
19+
20+
### Prerequisites
21+
22+
- You must be the owner or co-owner of a package on NuGet.org
23+
- Your sponsorship link platform must be from the approved list:
24+
- GitHub Sponsors
25+
- Patreon
26+
- Open Collective
27+
- Ko-fi
28+
- Tidelift
29+
- Liberapay
30+
31+
### Navigate to your package management page
32+
33+
1. Go to [NuGet.org](https://nuget.org) and sign in to your account.
34+
2. Select your username in the top right corner.
35+
3. Select **Manage Packages** from the dropdown menu.
36+
4. Find the package you want to add sponsorship information for and select the edit button.
37+
38+
### Access sponsorship settings
39+
40+
1. On your package management page, scroll down to find the **Sponsorship Links** section.
41+
2. Select to expand the collapsible **Sponsorship Links** section.
42+
3. You'll see a form where you can add sponsorship URLs.
43+
44+
![Screenshot of the manage package page with the Sponsorship Links section](media/sponsorship-section-manage-package-page.png)
45+
46+
### Add your sponsorship URLs
47+
48+
1. Enter your sponsorship URL in the text field:
49+
- Example: `https://github.com/sponsors/yourusername`
50+
- Example: `https://www.patreon.com/yourusername`
51+
52+
![Screenshot of the sponsorship URL form with example URL filled in](media/sponsorship-add-link.png)
53+
54+
2. Select the **Add** button.
55+
3. The system automatically validates that your URL is from an approved platform.
56+
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.
57+
58+
![Screenshot of a URL from a platform that is not approved](media/sponsorship-link-error-manage-package.png)
59+
60+
5. Each added sponsorship URL will have a **Remove** button next to it if you need to delete it.
61+
6. You can add up to 10 different sponsorship URLs per package ID.
62+
63+
### Verify your sponsorship URLs display correctly
64+
65+
1. Navigate to your package's public page on NuGet.org.
66+
2. Look for the **Sponsor** button in the package details **About** section.
67+
3. Select the **Sponsor** button to test that your URLs appear correctly in the popup.
68+
69+
![Screenshot of a package details page with the sponsorship links popup open](media/sponsorship-display-links.png)
70+
71+
## Finding and supporting packages
72+
73+
### Identify packages that need sponsorship
74+
75+
1. Browse to any package page on NuGet.org.
76+
2. Look for packages displaying a **Sponsor** button in the package details section.
77+
3. The **Sponsor** button indicates that the package maintainer is seeking financial support.
78+
79+
![Screenshot of a package details page with a Sponsor button](media/sponsorship-button-package-details-page.png)
80+
81+
### View available sponsorship options
82+
83+
1. Select the **Sponsor** button on the package page.
84+
2. A popup window appears showing all available sponsorship links for that package.
85+
86+
![Screenshot of a package details page with the sponsorship links popup open](media/sponsorship-display-links.png)
87+
88+
### Choose your preferred sponsorship platform
89+
90+
1. Review the available sponsorship options in the popup.
91+
2. Select your preferred platform to be redirected to the external sponsorship page.
92+
3. The link opens in a new tab or window, keeping the NuGet package page open.
93+
94+
> [!IMPORTANT]
95+
> 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.
96+
97+
## Frequently asked questions
98+
99+
**Can I add sponsorship information to older versions of my package?**
100+
101+
Yes! Sponsorship information is managed at the package ID level, so it automatically applies to all versions of your package, including previously published versions.
102+
103+
**What happens if my sponsorship platform URL changes?**
104+
105+
You can update your sponsorship URLs anytime through the package management page. Changes take effect immediately across all versions.
106+
107+
**Can I see analytics on how many people selected my sponsorship links?**
108+
109+
No, NuGet.org doesn't track sponsorship link selections. You'll need to check analytics on your sponsorship platform directly.
110+
111+
**Can I add custom sponsorship platforms not on the approved list?**
112+
113+
Currently, only the approved list of platforms is supported. This helps ensure security and legitimacy of sponsorship links. If you'd like to request a new platform to be added to the approved list, you can open an issue on the [NuGet Gallery repository](https://github.com/NuGet/NuGetGallery/issues).
114+
115+
**Does NuGet.org store my financial information?**
116+
117+
No personal or financial data is stored by NuGet.org. All transactions occur on secure external platforms that a maintainer chooses for sponsoring their packages.
118+

0 commit comments

Comments
 (0)