mirror of
https://github.com/maybe-finance/maybe.git
synced 2025-07-19 05:09:38 +02:00
Update issue templates
This commit is contained in:
parent
5f75e2e14f
commit
6212d57915
3 changed files with 21 additions and 53 deletions
33
.github/ISSUE_TEMPLATE/feature-specification.md
vendored
33
.github/ISSUE_TEMPLATE/feature-specification.md
vendored
|
@ -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.
|
|
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
@ -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.
|
|
21
.github/ISSUE_TEMPLATE/other.md
vendored
Normal file
21
.github/ISSUE_TEMPLATE/other.md
vendored
Normal file
|
@ -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**
|
Loading…
Add table
Add a link
Reference in a new issue