diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 0a8670589..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: 'bug :bug:' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**Victory version** -Which npm version are you using? - -**Code Sandbox link** -Please include a code sandbox link or a similar reproduction if possible. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. (You can exclude this if you included a reproduction) - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..a64ce10a9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,89 @@ +name: Bug report +description: Create a report to help us improve +projects: FormidableLabs/38 +labels: ["Type: Bug :bug:"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug! Please fill out the sections below. + + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + + - 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/FormidableLabs/victory/blob/main/CONTRIBUTING.md#contributor-covenant-code-of-conduct) + options: + - label: I agree to follow this project's Code of Conduct + required: true + + - type: input + attributes: + label: Victory version + validations: + required: true + + - type: input + attributes: + label: Code Sandbox link + description: | + Please include a code sandbox link or a similar reproduction if possible. + Issues with sandbox links are typically resolved faster. + You can use our preset [here](https://codesandbox.io/s/dj4f7t). + + - type: textarea + render: markdown + attributes: + label: Bug report + description: | + A clear and concise description of what the bug is. Please include any + screenshots or code snippets that may help us understand the issue. + validations: + required: true + + - type: textarea + render: markdown + attributes: + label: Steps to reproduce + placeholder: | + Steps to reproduce the behavior: + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + + - type: textarea + render: markdown + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + + - type: textarea + render: markdown + attributes: + label: Actual behavior + description: A clear and concise description of what actually happened. + + - type: textarea + render: markdown + attributes: + label: Environment + description: | + examples: + - **Device**: Desktop + - **OS**: Ubuntu 20.04 + - **Browser**: Chrome + - **Version**: 22 + value: | + - Device: + - OS: + - Node: + - npm: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d6..000000000 --- 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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..9f9d03c62 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,40 @@ +name: Feature request +description: Suggest a feature for this project +projects: FormidableLabs/38 +labels: ["Type: Enhancement :pencil2:"] +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the feature you are requesting. + options: + - label: I have searched the existing issues + required: true + + - 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/FormidableLabs/victory/blob/main/CONTRIBUTING.md#contributor-covenant-code-of-conduct) + options: + - label: I agree to follow this project's Code of Conduct + required: true + + - type: textarea + render: markdown + attributes: + label: Feature Request + description: | + **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. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 000000000..cf988b8eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,31 @@ +name: Question +description: Ask a question about using Victory. +projects: FormidableLabs/38 +labels: ["Type: Question :grey_question:"] +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the question you have. + options: + - label: I have searched the existing issues + required: true + + - 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/FormidableLabs/victory/blob/main/CONTRIBUTING.md#contributor-covenant-code-of-conduct) + options: + - label: I agree to follow this project's Code of Conduct + required: true + + - type: textarea + render: markdown + attributes: + label: Question + description: | + Any background information that might help us answer your questions. + Please include any screenshots or code snippets that may help us understand the issue. + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..2143131cc --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,35 @@ + + +### Description + + + +Fixes # (issue) + +#### Type of Change + + + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +### How Has This Been Tested? + + + +### Checklist: (Feel free to delete this section upon completion) + +- [ ] I have included a [changeset](../CONTRIBUTING.md#changesets) if this change will require a version change to one of the packages. +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] I have run `yarn run check` and all checks pass +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] My changes generate no new warnings +- [ ] Any dependent changes have been merged and published in downstream modules diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 7e7900b88..000000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,35 +0,0 @@ -# Questions - -**For discussions about features or questions about how to use Victory, please [start a new discussion](https://github.com/FormidableLabs/victory/discussions/new) rather than opening an issue.** - -# Bug Reports - -### Checklist - -- [ ] I have read through the [FAQ](https://formidable.com/open-source/victory/docs/faq) and [Guides](https://formidable.com/open-source/victory/guides/) - -- [ ] I am using the latest version of Victory - -- [ ] I've searched open issues to make sure I'm not opening a duplicate issue - -### The Problem - -Describe the issue you're seeing, and what you expect the behavior to be. - -### Reproduction - -Please try to reproduce the issue you're seeing in a sandbox. You can [fork this sandbox](https://codesandbox.io/s/dj4f7t) to get started. - -If you can't reproduce your issue in a sandbox, please create a minimal git repo that demonstrates the problem you're seeing. Include instructions for installing and reproducing your error. - -# Feature Requests - -### Checklist - -- [ ] I've read through the [Docs](https://formidable.com/open-source/victory/docs) and [Guides](https://formidable.com/open-source/victory/guides) to make sure this functionality doesn't already exist - -- [ ] I've searched open issues to make sure I'm not opening a duplicate issue - -### Description - -Please describe the feature you're requesting in detail.