Skip to content

Commit

Permalink
feat: add funding use guidelines (#299)
Browse files Browse the repository at this point in the history
Co-authored-by: ctcpip <ctcpip@users.noreply.github.com>
Co-authored-by: Ulises Gascón <ulisesgascongonzalez@gmail.com>
  • Loading branch information
3 people authored Nov 6, 2024
1 parent 91704b5 commit 2ee2a5a
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/adr/adr-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,45 @@

This is the base template that we use

```
```md

# ADR [Number]: [Title of Decision]

## Status

[Proposed | Accepted | Deprecated | Superseded by ADR [number]]

## Submitters

[List of people who proposed this decision. Include GitHub usernames or names with contact information if needed.]

- @username1
- @username2

## Decision Owners

[List of people responsible for driving the decision and following up on its implementation. This may include teams or subject matter experts.]

- @owner1
- @team1

## Context

Describe the problem, need, or feature request that prompted this decision. Include any relevant background information, constraints, and considerations that were taken into account.

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

## Decision

Clearly state the decision that was made. Describe the chosen solution or approach in detail so that others can understand what was decided.

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

## Rationale

Explain why this decision was made, including a discussion of the alternatives considered and why they were not chosen.

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

## Consequences

Describe the positive and negative outcomes of the decision, including any potential risks or technical debt.

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

## Implementation

(Optional, if relevant)
Outline the steps required to implement the decision. This section is particularly useful if the decision involves a series of actions or a roadmap.

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

## References

Include any external links, documents, discussions, or research that were referenced during the decision-making process.

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

## Changelog

Track changes or updates to this ADR over time. Include the date, author, and a brief description of each change.

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

```
```
44 changes: 44 additions & 0 deletions docs/adr/funding-guidelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: Funding Use Guidelines
description: Guidelines for spending project funding
labels: ADR
---

# ADR [Number]: Funding Use Guidelines

## Status

Proposed

## Submitters

- @ctcpip
- @UlisesGascon
- @wesleytodd

## Decision Owners

- @expressjs/express-tc

## Context

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.

## Decision

Funds are not automatically distributed.

TC members may request funds to be distributed for the following purposes:

- Living expenses (food, shelter, medicine/healthcare, transportation, utilities)
- The requester need not specify any detail other than the amount being requested.
- 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))_
- The requester should specify the event, location, and cost estimates for hotel and airfare.
- Equipment and hardware (devices, screens, internet services)
- The requester should specify the type of equipment or service needed and how it relates to their work on Express.

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.

## Implementation

Once approved, we will add this doc to the appropriate places within our project documentation (the contributing guide, website, OC landing page, etc).

0 comments on commit 2ee2a5a

Please sign in to comment.