Skip to content

Commit 9297748

Browse files
authored
Create funding.json for project funding information
See #222
1 parent 8acd361 commit 9297748

1 file changed

Lines changed: 71 additions & 0 deletions

File tree

funding.json

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
{
2+
"$schema": "https://fundingjson.org/schema/v1.1.0.json",
3+
4+
// Optional. Version of the manifest contents.
5+
"version": "v1.0.0",
6+
7+
// Required. The entity associated with the project, soliciting funds.
8+
// This can be an individual, organisation, community etc.
9+
"entity": {
10+
"type": "", // Required. [individual, group, organisation, other]. Use the closest approximation.
11+
"role": "", // Required. [owner, steward, maintainer, contributor, other]. Use the closest approximation.
12+
"name": "", // Required. Name of the entity. Max len 250.
13+
"email": "", // Required. Max len 250.
14+
"phone": "", // Optional. Generally suitable for organisations. Max len 32.
15+
"description": "", // Required. Information about the entity. Max len 2000.
16+
"webpageUrl": {
17+
"url": "", // Required. Webpage with information about the entity. Starts with https:// or http://. Max len 250.
18+
"wellKnown": "" // Optional. If the above URL's hostname does not match the hostname of the funding.json manifest, this establishes provenance. Starts with https:// or http://. Max len 250.
19+
}
20+
},
21+
22+
// Optional. One or more projects for which the funding is solicited.
23+
"projects": [{
24+
"guid": "", // Required. A short unique ID for the project. Lowercase-alphanumeric-dashes only. eg: my-cool-project. Max len 32.
25+
"name": "", // Required. Name of the project. Max len 250.
26+
"description": "", // Required. Description of the project. Max len 2000.
27+
"webpageUrl": {
28+
"url": "", // Required. Webpage with information about the project. Starts with https:// or http://. Max len 250.
29+
"wellKnown": "" // Optional. If the above URL's hostname does not match the hostname of the funding.json manifest, this establishes provenance. Starts with https:// or http://. Max len 250.
30+
},
31+
"repositoryUrl": {
32+
"url": "", // Required. URL of the repository where the project's source code and other assets are available. Starts with https:// or http://. Max len 250.
33+
"wellKnown": "" // Optional. If the above URL's hostname does not match the hostname of the funding.json manifest, this establishes provenance. Starts with https:// or http://. Max len 250.
34+
},
35+
"licenses": [], // Required. The project's licenses (up to 5). For standard licenses, use the license ID from the SDPX index prefixed by "spdx:". eg: "spdx:GPL-3.0", "spdx:CC-BY-SA-4.0"
36+
"tags": [] // Required. Up to 10 general tags describing the project. Lowercase-alphanumeric-dashes (max 32 chars). eg: ["programming", "developer-tools"]. For reference, see tags.txt
37+
}],
38+
39+
// Required.
40+
"funding": {
41+
// Required. This describes one or more channels via which the entity can receive funds.
42+
"channels": [{
43+
"guid": "", // Required. A short unique ID for the channel. Lowercase-alphanumeric-dashes only. eg: mybank, my-paypal. Max len 32.
44+
"type": "", // Required. [bank, payment-provider, cheque, cash, other].
45+
"address": "", // Optional. A short unstructured textual representation of the payment address for the channel. eg: "Account: 12345 (branch: ABCX)", "mypaypal@domain.com", "https://payment-url.com", or a physical address for cheques. Max len 250.
46+
"description": "" // Optional. Any additional description or instructions for the payment channel. Max len 500.
47+
}],
48+
49+
// Required. One or more funding and payment plans.
50+
"plans": [{
51+
"guid": "", // Required. A short unique ID for the plan. Lowercase-alphanumeric-dashes only. eg: mybank, paypal. Max len 32.
52+
"status": "", // Required. [active, inactive]. Indicates whether this plan is currently active or inactive.
53+
"name": "", // Required. Name of the funding plan. eg: "Starter support plan", "Infra hosting", "Monthly funding plan".
54+
"description": "", // Optional. Any additional description or instructions for the funding plan.
55+
"amount": 0, // Required. The solicited amount for this plan. 0 is a wildcard that indicates "any amount".
56+
"currency": "", // Required. Three letter ISO 4217 currency code. eg: USD
57+
"frequency": "", // Required. [one-time, weekly, fortnightly, monthly, yearly, other]
58+
"channels": [] // Required. One or more channel IDs defined in channels[] via which this plan can accept payments.
59+
}],
60+
61+
// Optional. A simple summary of funding history. Only include if at least one, either income or expenses, have to be communicated.
62+
"history": [{
63+
"year": 2024, // Required. Year (fiscal, preferably).
64+
"income": 0, // Optional.
65+
"expenses": 0, // Optional.
66+
"taxes": 0, // Optional.
67+
"currency": "", // Required. Three letter ISO 4217 currency code. eg: USD
68+
"description": "" // Optional. Any additional description. Max length 500.
69+
}]
70+
}
71+
}

0 commit comments

Comments
 (0)