Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add FEATURE REQUEST and BUG REPORT templates #48

Merged
merged 1 commit into from
Apr 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] "
labels: bug
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)

**Version, Branch, or Commit:**

What branch/commit/version of "next_rails" 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._

**Logs**

Include relevant log snippets or files here.

**I will abide by the [code of conduct](https://github.com/fastruby/next_rails/blob/main/CODE_OF_CONDUCT.md)**
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
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 "next_rails" 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](https://github.com/fastruby/next_rails/blob/main/CODE_OF_CONDUCT.md)**