From b05bbb8db5560358ca198dcb164362697b866989 Mon Sep 17 00:00:00 2001 From: TheCatLady <52870424+TheCatLady@users.noreply.github.com> Date: Sun, 21 Feb 2021 10:49:22 -0500 Subject: [PATCH] chore(github): Edit templates for consistency (#984) * chore(github): Edit templates for consistency * Address review comment for PR template * Fix stale label --- .github/ISSUE_TEMPLATE/bug_report.md | 54 +++++++++++------------ .github/ISSUE_TEMPLATE/feature_request.md | 15 ++++--- .github/PULL_REQUEST_TEMPLATE.md | 12 ++--- .github/stale.yml | 2 +- 4 files changed, 43 insertions(+), 40 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 972ad2f3..4b1d3790 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,45 +1,45 @@ --- name: Bug report -about: Create a report to help us improve +about: Submit a report to help us improve title: '' labels: 'awaiting-triage, type:bug' assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. +#### Description -**What version of Overseerr are you running?** -Please fill in the version you are currently running. +Please provide a clear and concise description of the bug or issue. -You can find it under: Settings -> About -> Version +#### Version -**To Reproduce** -Steps to reproduce the behavior: +What version of Overseerr are you running? (You can find this in Settings → About → Version.) -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +#### Steps to Reproduce -**Expected behavior** -A clear and concise description of what you expected to happen. +Please tell us how we can reproduce the undesired behavior. -**Screenshots** -If applicable, add screenshots to help explain your problem. +1. Go to [...] +2. Click on [...] +3. Scroll down to [...] +4. See error in [...] -**Desktop (please complete the following information):** +#### Expected Behavior -- OS: [e.g. iOS] -- Browser [e.g. chrome, safari] -- Version [e.g. 22] +Please provide a clear and concise description of what you expected to happen. -**Smartphone (please complete the following information):** +#### Screenshots -- Device: [e.g. iPhone6] -- OS: [e.g. iOS8.1] -- Browser [e.g. stock browser, safari] -- Version [e.g. 22] +If applicable, please provide screenshots depicting the problem. -**Additional context** -Add any other context about the problem here. +#### Device + +What device were you using when you encountered this issue? Please provide this information to help us reproduce and investigate the bug. + +- **Platform:** [e.g., desktop, smartphone, tablet] +- **Device:** [e.g., iPhone X, Surface Pro, Samsung Galaxy Tab] +- **OS:** [e.g., iOS 8.1, Windows 10, Android 11] +- **Browser:** [e.g., Chrome, Safari, Edge, Firefox] + +#### Additional Context + +Please provide any additional information that may be relevant or helpful. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 68b715d4..29b26fbd 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -6,11 +6,14 @@ labels: 'awaiting-triage, type: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 [...] +#### Description -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +Is your feature request related to a problem? If so, please provide a clear and concise description of the problem. E.g., "I'm always frustrated when [...]." -**Additional context** -Add any other context or screenshots about the feature request here. +#### Desired Behavior + +Provide a clear and concise description of what you want to happen. + +#### Additional Context + +Provide any additional information or screenshots that may be relevant or helpful. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b65966e7..d8187ecf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,13 +1,13 @@ #### Description -#### Screenshot (if UI related) +#### Screenshot (if UI-related) -#### Todos +#### To-Dos -- [ ] Sucessfully builds `yarn build` -- [ ] Translation Keys `yarn i18n:extract` -- [ ] Database migration created (if required) +- [ ] Successful build `yarn build` +- [ ] Translation keys `yarn i18n:extract` +- [ ] Database migration (if required) -#### Issues Fixed or Closed by this PR +#### Issues Fixed or Closed - Fixes #XXXX diff --git a/.github/stale.yml b/.github/stale.yml index 6a6201e3..eeed081e 100644 --- a/.github/stale.yml +++ b/.github/stale.yml @@ -8,7 +8,7 @@ exemptLabels: - security - dependencies # Label to use when marking an issue as stale -staleLabel: wontfix +staleLabel: stale # Comment to post when marking an issue as stale. Set to `false` to disable markComment: > This issue has been automatically marked as stale because it has not had