Skip to content

Commit

Permalink
docs: improve issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
adamdbradley committed Apr 12, 2023
1 parent ac10797 commit 2a3f215
Show file tree
Hide file tree
Showing 5 changed files with 105 additions and 77 deletions.
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: 🐞 Bug Report
description: Something does not work or is flaky! Let us know!
labels: [bug, triage]
title: '[🐞]'
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: description
attributes:
description: 'A clear and concise description of what you expected to happen instead. If you intend to submit a PR for this issue, tell us in the description. Thanks!'
label: Describe the bug
placeholder: I am doing ... What I expect is ... What actually happening is ...

validations:
required: true

- type: input
id: reproduction
attributes:
label: Reproduction
description: Please provide a link to a repo that can reproduce the problem you ran into. Please see the [contributing docs](https://github.com/BuilderIO/partytown/blob/main/CODE_OF_CONDUCT.md) for suggestions on create a reproduction. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required ([Why?](https://antfu.me/posts/why-reproductions-are-required)). If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided after 3 days, it will be auto-closed.
placeholder: Reproduction URL
validations:
required: true

- type: textarea
id: reproduction-steps
attributes:
label: Steps to reproduce
description: Please provide any reproduction steps that may need to be described.

- type: textarea
id: browser-info
attributes:
label: Browser Info
description: Which browser did you experience the issue on?
render: shell
placeholder: Chrome, Safari, Firefox, Edge
validations:
required: true

- type: textarea
id: additional_information
attributes:
label: Additional Information
validations:
required: false
57 changes: 0 additions & 57 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/docs_suggestion.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: 📖 Documentation Suggestion
description: Suggestions on how we can improve the documentation.
title: '[📖]'
labels: [documentation]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out docs suggestion! However, if you think it's something you can fix yourself, please submit a PR instead.
In every doc page, you will be able to find the "Edit this page" in the right menu!
- type: textarea
id: description
attributes:
description: 'A clear and concise description of your suggestion to improve the docs.'
label: Suggestion
validations:
required: true
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: ✨ Feature Request
description: Suggest an idea for this project.
labels: [enhancement, triage]
title: '[✨]'
body:
- type: textarea
id: use_case
attributes:
label: 'Is your feature request related to a problem?'
description: 'A clear and concise description of what the problem is.'
validations:
required: true

- type: textarea
id: solution
attributes:
label: "Describe the solution you'd like"
description: 'A clear and concise description of what you want to happen.'
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: "Describe alternatives you've considered"
description: "A clear and concise description of any alternative solutions or features you've considered."
validations:
required: true

- type: textarea
id: additional_context
attributes:
label: 'Additional context'
description: 'Add any other context or screenshots about the feature request here.'
validations:
required: false
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

1 comment on commit 2a3f215

@vercel
Copy link

@vercel vercel bot commented on 2a3f215 Apr 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.