Browse Source

New issue templates! (#341)

dev
Andy Meneely 4 years ago committed by GitHub
parent
commit
ff0e58b525
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 39
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 22
      .github/ISSUE_TEMPLATE/feature_request.md
  3. 10
      .github/ISSUE_TEMPLATE/help-wanted.md

39
.github/ISSUE_TEMPLATE/bug_report.md

@ -0,0 +1,39 @@
---
name: Bug report
about: Report something that seems wrong
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. My code looks like this...
2. When I run it like this...
3. I see this error...
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
We love screenshots!
* Windows: `Print Screen` key and then `ctrl+v` directly into GitHub issues here.
* Shift + Command + 3, then `command+v` directly into GitHub issues here.
**Environment**
- OS: (e.g. Windows 11)
- Ruby version (e.g. 2.7, 3.0)
**Additional context**
Add any other context about the problem here.
**Check the following:**
- [] I have updated Squib to the latest version.
- [] I have checked the Squib issues backlog for something similar
- [] I have attempted to make a minimal script demonstrating my problem
- [] I have reviewed the [Squib Docs](https://squib.readthedocs.io/) and there's still a problem

22
.github/ISSUE_TEMPLATE/feature_request.md

@ -0,0 +1,22 @@
---
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. Make an example of what you want the syntax to look like.
**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.
- [] I might be interested in implementing this myself

10
.github/ISSUE_TEMPLATE/help-wanted.md

@ -0,0 +1,10 @@
---
name: Help Wanted
about: Need help doing something in Squib?
title: Help! How do I...
labels: help wanted
assignees: andymeneely
---
Loading…
Cancel
Save