From 7a3487390482da7afc4102d05e7b9d0899dda76b Mon Sep 17 00:00:00 2001 From: Fiona Date: Thu, 21 Apr 2022 16:52:18 -0400 Subject: [PATCH] Add templates for feature request and bug reporting --- .github/ISSUE_TEMPLATE/bug_report.md | 51 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 40 ++++++++++++++++++ 2 files changed, 91 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..58f4848 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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)** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..5bde9f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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 \** > **I do \** > **And then I do \** > **And I see \** + +**Problem:** + +Please include a detailed description of the problem this feature would solve. + +> **As a \** > **I want to \** > **So that I can achieve a \** + +**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)**