From 6212d579157496bb2bdae2d2f4ef2274f7b3f070 Mon Sep 17 00:00:00 2001 From: Zach Gollwitzer Date: Mon, 20 May 2024 11:15:32 -0400 Subject: [PATCH] Update issue templates --- .../ISSUE_TEMPLATE/feature-specification.md | 33 ------------------- .github/ISSUE_TEMPLATE/feature_request.md | 20 ----------- .github/ISSUE_TEMPLATE/other.md | 21 ++++++++++++ 3 files changed, 21 insertions(+), 53 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature-specification.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/other.md diff --git a/.github/ISSUE_TEMPLATE/feature-specification.md b/.github/ISSUE_TEMPLATE/feature-specification.md deleted file mode 100644 index 3146a8e0..00000000 --- a/.github/ISSUE_TEMPLATE/feature-specification.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Feature Specification -about: A fully scoped feature with designs, requirements, and implementation plan -title: 'Feature: ' -labels: ":rocket: Feature" -assignees: '' - ---- - -_If your feature requires designs, UI changes, or input from the Maybe team, you should open a feature request instead. This template is for a **fully scoped and ready** feature. _ - -## Feature Overview - -## Requirements - -_If there is a missing / incorrect requirement, please leave a comment before starting work on this._ - -- [ ] Requirement 1 - -## Implementation Suggestions - -_Below are some ideas for implementation to get you started. Use your best judgment here—if there's a better way to do things, go for it!_ - -## Designs - -Below are the designs you should follow while implementing this: - -## Reminders - -- Make sure to review our [contributing guidelines](https://github.com/maybe-finance/maybe/blob/main/CONTRIBUTING.md) before starting on an issue -- We do our best to define a clear spec for new features and fixes, but think of them as "suggestions", not "hard requirements". We welcome ideas and suggestions! - - If you see missing requirements to this issue, please leave a comment below explaining what is missing and why it is important. - - If you see a requirement that you think is _incorrect_ or _not optimal_, please leave a comment explaining what you think needs to change below. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 87314dd8..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: 'Feature Request: ' -labels: ":bulb: Feature Request" -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md new file mode 100644 index 00000000..6a230e6e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.md @@ -0,0 +1,21 @@ +--- +name: Other +about: All other issues +title: '' +labels: '' +assignees: '' + +--- + +**PLEASE READ before opening an issue:** + +- Is this a feature request? Please [open a feature request discussion](https://github.com/maybe-finance/maybe/discussions/new?category=feature-requests). +- Do you need help or have a question? Please [open a discussion](https://github.com/maybe-finance/maybe/discussions/new/choose) or [join our Discord](https://link.maybe.co/discord) and post to the "help" channel. + +---------------------- + +**Is this issue related to a problem? Please describe.** + +**Describe the work that needs to be done to address this issue** + +**Additional context**