Skip to content

Commit

Permalink
docs: include issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
nud3l authored Aug 25, 2023
1 parent 781cd66 commit ed0fee6
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
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.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/roadmap-item.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Roadmap item
about: Propose a large item for the roadmap https://github.com/orgs/bob-collective/projects/1/views/1
title: ''
labels: roadmap
assignees: ''

---

# Abstract

[ADD HERE]

A 2-3 sentence description of the proposal.

# Motivation

[ADD HERE]

Provide a motivation for including this proposal.

# Specification

[ADD HERE]

Provide a high-level, functional specification. The specification should be focussed on what the proposal is trying to achieve.

# Reference Implementation

[OPTIONAL][ADD HERE]

Provide a reference implementation, proof of concept, or basic pseudo-code for a better grounds to discuss the suggested implementation. The reference implementation focusses on the how.

# Security Considerations

[ADD HERE]

Provide reasoning around security implications:

- The proposal itself
- The proposal's implications to the existing system

0 comments on commit ed0fee6

Please sign in to comment.