Skip to content

Commit

Permalink
docs: update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jef committed Aug 11, 2021
1 parent 9c346e7 commit 7171113
Show file tree
Hide file tree
Showing 3 changed files with 96 additions and 39 deletions.
93 changes: 55 additions & 38 deletions .github/ISSUE_TEMPLATE/bug-report.md
@@ -1,38 +1,55 @@
---
name: "\U0001F41B Bug report"
about: Report a bug for this project
title: ''
labels: ''
assignees: ''

---

## Expected Behavior

<!-- Tell us what should happen -->

## Current Behavior

<!-- Tell us what happens instead of the expected behavior -->

## Steps to Reproduce

<!-- Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. -->
<!-- Include code to reproduce, if relevant -->

## Environment

- OS:

<details>
<summary>dotenv</summary>

```dotenv
# Place your dotenv within these backticks. Be sure to remove any secrets/passwords.
```

</details>

## Logs

<!-- Provide a brief log -->
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels:
- 'type: bug'
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: What did you expect to happen?
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: What happened?
placeholder: Tell us what you see!
validations:
required: true
- type: dropdown
id: operating-system
attributes:
label: What operating system are you seeing the problem on?
multiple: true
options:
- Linux
- Windows
- macOS
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: textarea
id: dotenv
attributes:
label: Configuration
description: Please copy and paste your `dotenv`. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/jef/streetmerchant/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
@@ -0,0 +1,40 @@
name: Feature Request
description: Formalize a feature request from GitHub Discussions
title: "[Feature]: "
labels:
- 'type: feature'
body:
- type: textarea
id: proposed-solution
attributes:
label: Proposed solution
description: What is solution to this feature request?
placeholder: Solution description.
validations:
required: true
- type: textarea
id: objective
attributes:
label: Objective
description: Link to discussion.
placeholder: https://github.com/jef/streetmerchant/discussions
validations:
required: true
- type: textarea
id: goals
attributes:
label: Goals
description: What is the purpose of feature request?
placeholder: Add all relevant goals.
- type: textarea
id: non-goals
attributes:
label: Non-goals
description: What else could be accomplished with this feature request, but is currently out of scope?
placeholder: Add all relevant non-goals.
- type: textarea
id: anti-goals
attributes:
label: Anti-goals
description: What could go wrong (side effects) if we implement this feature request?
placeholder: Add all relevant anti-goals.
2 changes: 1 addition & 1 deletion .github/workflows/stale.yaml
Expand Up @@ -23,6 +23,6 @@ jobs:
stale-pr-message: ${{ env.STALE_MESSAGE }}
env:
CLOSE_MESSAGE: 'This issue has been closed because it is stale. Reopen if necessary.'
EXEMPT_LABEL: 'priority: low,priority: normal, priority: high,status: help wanted,status: in progress,status: needs triage'
EXEMPT_LABEL: 'priority: low,priority: normal,priority: high,status: help wanted,status: in progress,status: needs triage'
STALE_LABEL: 'status: stale'
STALE_MESSAGE: 'This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 10 days'

0 comments on commit 7171113

Please sign in to comment.