Skip to content

Commit 2ee2a5a

Browse files
wesleytoddctcpipUlisesGascon
authored
feat: add funding use guidelines (#299)
Co-authored-by: ctcpip <[email protected]> Co-authored-by: Ulises Gascón <[email protected]>
1 parent 91704b5 commit 2ee2a5a

File tree

2 files changed

+59
-3
lines changed

2 files changed

+59
-3
lines changed

docs/adr/adr-template.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,45 @@
22

33
This is the base template that we use
44

5-
```
5+
```md
6+
67
# ADR [Number]: [Title of Decision]
78

89
## Status
10+
911
[Proposed | Accepted | Deprecated | Superseded by ADR [number]]
1012

1113
## Submitters
14+
1215
[List of people who proposed this decision. Include GitHub usernames or names with contact information if needed.]
16+
1317
- @username1
1418
- @username2
1519

1620
## Decision Owners
21+
1722
[List of people responsible for driving the decision and following up on its implementation. This may include teams or subject matter experts.]
23+
1824
- @owner1
1925
- @team1
2026

2127
## Context
28+
2229
Describe the problem, need, or feature request that prompted this decision. Include any relevant background information, constraints, and considerations that were taken into account.
2330

2431
- **Why do we need this decision?**
2532
- **What problem does it solve or avoid?**
2633
- **Are there any existing issues/discussions/pull requests related to this?** (Include links to relevant GitHub issues, forum threads, or discussion channels.)
2734

2835
## Decision
36+
2937
Clearly state the decision that was made. Describe the chosen solution or approach in detail so that others can understand what was decided.
3038

3139
- **What will be done?**
3240
- **What will not be done?** (If applicable, specify what was explicitly ruled out.)
3341

3442
## Rationale
43+
3544
Explain why this decision was made, including a discussion of the alternatives considered and why they were not chosen.
3645

3746
- **Alternatives Considered:**
@@ -41,13 +50,15 @@ Explain why this decision was made, including a discussion of the alternatives c
4150
- **Why is this decision the best option?** (Explain the key factors that influenced this choice.)
4251

4352
## Consequences
53+
4454
Describe the positive and negative outcomes of the decision, including any potential risks or technical debt.
4555

4656
- **Positive Impact**: What benefits does this decision bring to the project?
4757
- **Negative Impact**: What challenges or limitations does this introduce?
4858
- **Mitigations**: How will we address potential drawbacks or issues?
4959

5060
## Implementation
61+
5162
(Optional, if relevant)
5263
Outline the steps required to implement the decision. This section is particularly useful if the decision involves a series of actions or a roadmap.
5364

@@ -56,19 +67,20 @@ Outline the steps required to implement the decision. This section is particular
5667
- **Estimated Effort**: Provide a rough estimate of time or effort needed.
5768

5869
## References
70+
5971
Include any external links, documents, discussions, or research that were referenced during the decision-making process.
6072

6173
- [Link to relevant GitHub issue or pull request](#)
6274
- [Link to forum discussion](#)
6375
- [Documentation or research sources](#)
6476

65-
6677
## Changelog
78+
6779
Track changes or updates to this ADR over time. Include the date, author, and a brief description of each change.
6880

6981
- **[YYYY-MM-DD]**: [@username] - [Brief description of the change]
7082
- Example: **[2024-10-22]**: @owner1 - Updated the decision to include support for Redis caching.
7183
- **[YYYY-MM-DD]**: [@username] - [Brief description of the change]
7284
- Example: **[2025-01-15]**: @username2 - Deprecated this ADR due to a shift in the database strategy.
7385

74-
```
86+
```

docs/adr/funding-guidelines.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Funding Use Guidelines
3+
description: Guidelines for spending project funding
4+
labels: ADR
5+
---
6+
7+
# ADR [Number]: Funding Use Guidelines
8+
9+
## Status
10+
11+
Proposed
12+
13+
## Submitters
14+
15+
- @ctcpip
16+
- @UlisesGascon
17+
- @wesleytodd
18+
19+
## Decision Owners
20+
21+
- @expressjs/express-tc
22+
23+
## Context
24+
25+
We have an Open Collective but we originally decided to wait on setting guidelines for how we will spend the funds. Now that we have landed PRs to include the `funding` field in `package.json` and also a link in the footer of the website, we wanted to have some loose guidelines so contributors know a little about how we intend to use financial support for the project.
26+
27+
## Decision
28+
29+
Funds are not automatically distributed.
30+
31+
TC members may request funds to be distributed for the following purposes:
32+
33+
- Living expenses (food, shelter, medicine/healthcare, transportation, utilities)
34+
- The requester need not specify any detail other than the amount being requested.
35+
- Travel (hotel and airfare) to events related to Express or the greater Node/JS ecosystem. _Legal Requirement: at least 18 years old and recognized as adults in both the country of departure and the destination country, based on local laws (ref: [Age of Majority](https://en.wikipedia.org/wiki/Age_of_majority))_
36+
- The requester should specify the event, location, and cost estimates for hotel and airfare.
37+
- Equipment and hardware (devices, screens, internet services)
38+
- The requester should specify the type of equipment or service needed and how it relates to their work on Express.
39+
40+
Requests will be reviewed at the next possible opportunity, privately during an Express TC meeting. The Express TC also reserves the right to amend these guidelines via our standard decision making process.
41+
42+
## Implementation
43+
44+
Once approved, we will add this doc to the appropriate places within our project documentation (the contributing guide, website, OC landing page, etc).

0 commit comments

Comments
 (0)