Add funding support & npm fund subcommand

accepted/0017-add-funding-support.md

@@ -0,0 +1,138 @@
+# Add `funding` support to `package.json`
+
+## Summary
+
+This RFC identifies an initial means of tooling to describe & notify consumers of a package's monetary support information. `npm` has been [vocal about our commitment](https://blog.npmjs.org/post/187382017885/supporting-open-source-maintainers) to providing a means for package maintainers to more sustainably support their work & this reflects an initial step toward that goal. 
+
+## Motivation
+
+Package maintainers want to clearly indentify how their software is currently, or could be in the future, supported monetarily.
+
+## Detailed Explanation
+
+* See [Prior Art](#prior-art)
+* Provide a means to **reference** existing backers or funding opportunities in `package.json`
+* Provide a means to **define the type** of backing or funding opportunities in `package.json`
+* Provide a means to **notify** package consumers of backers or funding opportunites with the cli
+* Provide a means to **view** dependency's backers or funding opportunites with the cli
+* Provide a means to **view** a package's backers or funding opportunites
+
+##  Rationale & Alternatives
+* Rationale: This is a straightforward and easily implemented solution to take the first step toward supporting Open Source Package Maintainence sustainability
+* Rationale: Building this functionality into the package management layer is the only reliable way to push funding notifications to the vast majority of developers who already use npm
+* Alternative: Continue to rely on third-party, opt-in, tools & platforms that only support a fraction of the desired audience
+* Alternative: Continue debating a larger, more complex schema /w correspondingly more complex tooling
+
+## Implementation
+
+* Add a `funding` field to `package.json`
+  * supports a string URL or object with...
+  * keys that support arbitrary string identifiers
+    * ex. `"sponsor"`, `"sponsors"`, `"donations"`, `"bounties"`, `"contributors"`, `"patrons"` etc.
+  * values that represent a string URL or an array of URLs
+* Add notification at the end of output of package installation that references the number of packages with `funding` defined 
+  * ex. `23 packages are looking for funding. Run "npm fund" to find out more.`
+* Add `--no-fund` flag to opt-out of the funding notification when installing
+* Add `npm fund <pkg>` subcommand: 
+  * if a singular URL is defined for the specified package's `funding` field, it will try to open it using the `--browser` config param (similar to `npm repo <pkg>`)
+  * if an object is defined for the specified package's `funding` field, it will print out the tree of values
+  * if no package is specified, `npm` will try to print out a tree of all the funding references defined in the current project's installed dependencies
+* Add a visual representation for the funding field/value on package pages on `npmjs.com`
+
+
+**Examples of `funding` usage in `package.json`:**
+```
+{
+  ...
+  "funding": "https://www.patreon.com/my-account"
+  ...
+}
+```
+```
+{
+  ...
+  "funding": {
+    "foundations": "https://openjsf.org/"
+  }
+  ...
+}
+```
+```
+{
+  ...
+  "funding": {
+    "corporations": [
+      "https://microsoft.com/",
+      "https://google.com/"
+    ]
+  }
+  ...
+}
+```
+```
+{
+  ...
+  "funding": {
+    "sponsor": [
+      "https://github.com/users/my-account/sponsorship",
+      "https://opencollective.com/my-account",
+      "https://www.patreon.com/my-account"
+    ],
+    "sponsors": "https://github.com/users/my-account/sponsorship#sponsors",
+    "contributors": "https://opencollective.com/my-account#section-contributors",
+    "patrons": [
+      "https://patrons-site-one.com/",
+      "https://patrons-site-two.com/",
+      "https://patrons-site-three.com/"
+    ]
+  }
+  ...
+}
+```
+
+**Example of `npm fund <pkg>`:**
+```
+$ npm fund example-package 
+└─ example-package
+   ├─ sponsor
+   │  ├─ 0: https://github.com/users/my-account/sponsorship
+   │  ├─ 1: https://opencollective.com/my-account
+   │  └─ 2: https://www.patreon.com/my-account
+   ├─ sponsors: https://github.com/users/my-account/sponsorship#sponsors
+   ├─ contributors: https://opencollective.com/my-account#section-contributors
+   └─ patrons
+      ├─ 0: https://patrons-site-one.com/
+      ├─ 1: https://patrons-site-two.com/
+      └─ 2: https://patrons-site-three.com/
+```
+
+## Prior Art
+
+* [Open Collective](https://github.com/opencollective/opencollective)
+* [GitHub Sponsors](https://github.com/sponsors)
+* [License Zero](https://licensezero.com/)
+* [GitCoin](https://gitcoin.co/products)
+* [Feross: `thanks`](https://github.com/feross/thanks)
+* [Feross: `funding`](https://github.com/feross/funding)
+* [Indieweb: payment](https://indieweb.org/payment)
+* [microformats: `rel-payment`](http://microformats.org/wiki/rel-payment)
+* [Shields.io: Funding](https://shields.io/category/funding)
+* [ThanksApp: Donate Spec](https://github.com/ThanksApp/donate-spec)
+* [Bevry: `sponsored`](https://github.com/bevry-archive/sponsored)
+* [OGAG: `civic.json`](http://open.dc.gov/civic.json/)
+
+#### Other Work & Conversations
+
+1. <i id="r1"></i>[PM WG: "Document support levels" Draft](https://github.com/nodejs/package-maintenance/blob/master/docs/drafts/PACKAGE-SUPPORT.md)
+2. <i id="r2"></i>[PM WG: "Document support levels" Blog post to announce](https://github.com/nodejs/package-maintenance/issues/228)
+3. <i id="r3"></i>[PM WG: "Document support levels" Blog post to validate](https://github.com/nodejs/package-maintenance/issues/244)
+4. <i id="r4"></i>[PM WG: `support` field `license` Issue](https://github.com/nodejs/package-maintenance/issues/218)
+5. <i id="r5"></i>[PM WG: "Future direction of `support` field" Issue](https://github.com/nodejs/package-maintenance/issues/241)
+6. <i id="r6"></i>[npm: `sustainability` PR](https://github.com/npm/cli/pull/187)
+7. <i id="r7"></i>[npm: `support` PR](https://github.com/npm/cli/pull/246)
+8. <i id="r8"></i>[`thanks`: "Read URL from `package.json`" Issue](https://github.com/feross/thanks/issues/2)
+9. <i id="r9"></i>[`funding`: "Collaborate with the PM WG" Issue](https://github.com/feross/funding/issues/15)
+10. <i id="r10"></i>[Differences between: "author", "contributors", "maintainers" & "owner"](https://github.com/npm/www/issues/133#issuecomment-284906561)
+
+## Unresolved Questions and Bikeshedding
+* [ ] Highlight this proposal to the [Package Maintaince WG](https://github.com/nodejs/package-maintenance/)