Skip to content

Commit 987bf77

Browse files
authored
Merge pull request #37 from menloresearch/feat/add-issue-template
feat: add issue templates
2 parents ae0320d + 08e7bbc commit 987bf77

File tree

5 files changed

+92
-0
lines changed

5 files changed

+92
-0
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: If something isn't working as expected 🤔
4+
title: 'bug: '
5+
type: Bug
6+
---
7+
8+
**Version:** e.g. 0.5.x-xxx
9+
10+
## Describe the Bug
11+
<!-- A clear & concise description of the bug -->
12+
13+
14+
## Steps to Reproduce
15+
1.
16+
17+
## Screenshots / Logs
18+
<!-- You can find logs in: Setting -> General -> Data Folder -> App Logs -->
19+
20+
21+
## Operating System
22+
- [ ] MacOS
23+
- [ ] Windows
24+
- [ ] Linux
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: 🚀 Feature Request
3+
about: Suggest an idea for this project 😻!
4+
title: 'idea: '
5+
type: Idea
6+
---
7+
8+
## Problem Statement
9+
<!-- Describe the problem you're facing -->
10+
11+
## Feature Idea
12+
<!-- Describe what you want instead. Examples are welcome! -->

.github/ISSUE_TEMPLATE/3-epic.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: 🌟 Epic
3+
about: User stories and specs
4+
title: 'epic: '
5+
type: Epic
6+
---
7+
8+
## User Stories
9+
10+
- As a [user type], I can [do something] so that [outcome]
11+
12+
## Not in scope
13+
14+
-
15+
16+
## User Flows & Designs
17+
18+
- Key user flows
19+
- Figma link
20+
- Edge cases
21+
- Error states
22+
23+
## Engineering Decisions
24+
25+
- **Technical Approach:** Brief outline of the solution.
26+
- **Key Trade-offs:** What’s been considered/rejected and why.
27+
- **Dependencies:** APIs, services, libraries, teams.

.github/ISSUE_TEMPLATE/4-goal.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: 🎯 Goal
3+
about: Roadmap goals for our users
4+
title: 'goal: '
5+
type: Goal
6+
---
7+
8+
## 🎯 Goal
9+
<!-- Short description of our goal -->
10+
11+
## 📖 Context
12+
<!-- Give a description of our current context -->
13+
14+
## ✅ Scope
15+
<!-- High lever description of what we are going to deliver -->
16+
17+
## ❌ Out of Scope
18+
<!-- What we are not targeting / delivering / discussing in this goal -->
19+
20+
## 🛠 Deliverables
21+
<!-- What we are the tangible deliverables for this goal -->
22+
23+
## ❓Open questions
24+
<!-- What are we not sure about and need to discuss more -->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Jan Browser Discussions
4+
url: https://github.com/orgs/menloresearch/discussions/categories/q-a
5+
about: Get help, discuss features & roadmap, and share your projects

0 commit comments

Comments
 (0)