From 2ee2a5aaa6619744c44034482f6f64eee1bd9a84 Mon Sep 17 00:00:00 2001 From: Wes Todd Date: Wed, 6 Nov 2024 11:07:13 +0000 Subject: [PATCH] feat: add funding use guidelines (#299) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: ctcpip Co-authored-by: Ulises Gascón --- docs/adr/adr-template.md | 18 +++++++++++--- docs/adr/funding-guidelines.md | 44 ++++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+), 3 deletions(-) create mode 100644 docs/adr/funding-guidelines.md diff --git a/docs/adr/adr-template.md b/docs/adr/adr-template.md index 0709318..d06f6f9 100644 --- a/docs/adr/adr-template.md +++ b/docs/adr/adr-template.md @@ -2,23 +2,30 @@ 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?** @@ -26,12 +33,14 @@ Describe the problem, need, or feature request that prompted this decision. Incl - **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:** @@ -41,6 +50,7 @@ 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? @@ -48,6 +58,7 @@ Describe the positive and negative outcomes of the decision, including any poten - **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. @@ -56,14 +67,15 @@ 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] @@ -71,4 +83,4 @@ Track changes or updates to this ADR over time. Include the date, author, and a - **[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. -``` \ No newline at end of file +``` diff --git a/docs/adr/funding-guidelines.md b/docs/adr/funding-guidelines.md new file mode 100644 index 0000000..2c43854 --- /dev/null +++ b/docs/adr/funding-guidelines.md @@ -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).