diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 00000000..4a8a6dbf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 8f359ae0..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - - - -- [ ] I am interested in helping provide a fix! - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Reproduction link** -Please include a link to a Stackblitz or Codesandbox reproducing the issue. We will need to see the issue reproduced with hand-written code - we can't debug giant minified third party scripts directly. If you do not include a clean and simple reproduction of your issue, we won't be able to look into it until you do. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Partytown version** -What version of Partytown you are using, e.g. `0.0.1` - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/docs_suggestion.yml b/.github/ISSUE_TEMPLATE/docs_suggestion.yml new file mode 100644 index 00000000..7a8c1eb1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs_suggestion.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml new file mode 100644 index 00000000..572194d0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -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 [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here.