1
0
Fork 0
mirror of https://github.com/maybe-finance/maybe.git synced 2025-07-19 13:19:39 +02:00

Update issue templates

This commit is contained in:
Zach Gollwitzer 2024-04-18 08:34:50 -04:00 committed by GitHub
parent 9bda7efc3f
commit 4708e85da3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 69 additions and 0 deletions

38
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View file

@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ":bug: Bug"
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Additional context**
Add any other context about the problem here.

31
.github/ISSUE_TEMPLATE/feature-spec.md vendored Normal file
View file

@ -0,0 +1,31 @@
---
name: Feature Spec
about: A fully scoped feature that is ready to be worked on.
title: 'Feature: '
labels: ":rocket: Feature"
assignees: ''
---
## 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.