Skip to content

Commit

Permalink
Merge pull request #39 from rubymem/add_issue_template
Browse files Browse the repository at this point in the history
Add issue template
  • Loading branch information
bronzdoc authored Mar 19, 2021
2 parents 0d0e7e4 + f491466 commit a3713ab
Show file tree
Hide file tree
Showing 2 changed files with 106 additions and 0 deletions.
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: ''
assignees: ''

---

**IMPORTANT: please make sure you ask yourself all intro questions and fill all sections of the template.**

**Before we start...:**

- [ ] I checked the documentation and found no answer
- [ ] I checked to make sure that this issue has not already been filed
- [ ] I'm reporting the issue to the correct repository (for multi-repository projects)


**Branch/Commit:**

Inform what branch/commit of Skunk.fyi you are using.

**Expected behavior:**

Please include a detailed description of the behavior you were expecting when you encountered this issue.

**Actual behavior:**

Please include a detailed description of the actual behavior of the application.

**Steps to reproduce:**

How do I achieve this behavior? Use the following format to provide a step-by-step guide:

1. Step 1: ...
2. Step 2: ...

**Context and environment:**

Provide any relevant information about your setup (Customize the list accordingly based on what info is relevant to this project)

1. Version of the software the issue is being opened for.
2. Operating System
3. Operating System version
4. Ruby version

_Delete any information that is not relevant._

If you are unable to reproduce the bug, add the **Non-Reproducible** tag and describe the steps you followed leading to the bug to the best of your recollection.

**Screenshots and Videos**

If the issue has an effect in the frontend, include any relevant screenshots and videos here.

**Logs**

Include relevant log snippets or files here.

**I will abide by the [code of conduct] (code_of_conduct.md)**
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: Feature request
about: Request a new feature
title: "[REQUEST]"
labels: 'enhancement'
assignees: ''

---

**IMPORTANT: please make sure you ask yourself all intro questions and fill all sections of the template.**

**Before we start...:**

- [ ] I checked the documentation and didn't find this feature
- [ ] I checked to make sure that this feature has not already been requested


**Branch/Commit:**

Inform what branch/commit/version of Skunk.fyi you are using.

**Describe the feature:**

Please include a detailed description of the feature you are requesting and any detail on it’s expected behavior.

> **As a \<role name\>**
> **I do \<something\>**
> **And then I do \<another action\>**
> **And I see \<some result\>**
**Problem:**

Please include a detailed description of the problem this feature would solve.

> **As a \<role name\>**
> **I want to \<do something\>**
> **So that I can achieve a \<goal\>**
**Mockups:**

Include any mockup idea related to the requested feature if it applies.

**Resources:**

If you have resources related to the implementation or research for this feature, add them here.

**I will abide by the [code of conduct] (code_of_conduct.md)**

0 comments on commit a3713ab

Please sign in to comment.