diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index f14a4aa..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,99 +0,0 @@ -name: "\U0001F41E Bug report" -description: Create a report to help us improve -body: - - type: checkboxes - attributes: - label: "Before you start, make sure to:" - description: More than half issues of json-editor-vue turned out to be invalid or irrelevant. - options: - - label: Read the [doc](https://github.com/cloydlau/json-editor-vue/blob/main/README.md) - required: true - - label: Be aware that json-editor-vue is only a Vue wrapper for [svelte-jsoneditor](https://github.com/josdejong/svelte-jsoneditor) - required: true - - label: Have a try at the latest version - required: true - - label: Search to see if your issue already exists - required: true - - label: Look for / ask questions on [Stack Overflow](https://stackoverflow.com/questions/ask) - required: false - - type: input - id: json-editor-vue_version - attributes: - label: json-editor-vue version - validations: - required: true - - type: input - id: vanilla-jsoneditor_version - attributes: - label: vanilla-jsoneditor version - validations: - required: true - - type: input - id: vue_version - attributes: - label: vue version - validations: - required: true - - type: input - id: vue-composition-api_version - attributes: - label: "@vue/composition-api version" - placeholder: Only for Vue 2.6 or earlier - validations: - required: false - - type: input - id: nuxt_version - attributes: - label: nuxt version - validations: - required: false - - type: input - id: reproduction-link - attributes: - label: Link to minimal reproduction - description: | - The easiest way to provide a reproduction is by showing the bug in [The SFC Playground](https://sfc.vuejs.org/). - If it cannot be reproduced in the playground and requires a proper build setup, try [StackBlitz](https://vite.new/vue). - If neither of these are suitable, you can always provide a GitHub repository. - - The reproduction should be **minimal** - i.e. it should contain only the bare minimum amount of code needed - to show the bug. See [Bug Reproduction Guidelines](https://github.com/cloydlau/json-editor-vue/blob/main/.github/bug-repro-guidelines.md) for more details. - - Please do not just fill in a random link. The issue will be closed if no valid reproduction is provided. - [Why reproduction is required?](https://antfu.me/posts/why-reproductions-are-required) - placeholder: Reproduction Link - validations: - required: true - - type: textarea - id: steps-to-reproduce - attributes: - label: Steps to reproduce - description: | - What do we need to do after opening your repro in order to make the bug happen? Clear and concise reproduction instructions are important for us to be able to triage your issue in a timely manner. Note that you can use [Markdown](https://guides.github.com/features/mastering-markdown/) to format lists and code. - placeholder: Steps to reproduce - validations: - required: true - - type: textarea - id: expected - attributes: - label: What is expected? - validations: - required: true - - type: textarea - id: actually-happening - attributes: - label: What is actually happening? - validations: - required: true - - type: textarea - id: system-info - attributes: - label: System Info - description: Output of `npx envinfo --system --npmPackages json-editor-vue,vanilla-jsoneditor,vue,@vue/composition-api,nuxt --binaries --browsers` - render: shell - placeholder: System, Binaries, Browsers - - type: textarea - id: additional-comments - attributes: - label: Any additional comments? - description: e.g. some background/context of how you ran into this bug. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 3ba13e0..0000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1 +0,0 @@ -blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml deleted file mode 100644 index b03c02f..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,37 +0,0 @@ -name: "\U0001F680 New feature proposal" -description: Suggest an idea for this project -labels: [":sparkles: feature request"] -body: - - type: checkboxes - attributes: - label: "Before you start, make sure to:" - description: More than half issues of json-editor-vue turned out to be invalid or irrelevant. - options: - - label: Read the [doc](https://github.com/cloydlau/json-editor-vue/blob/main/README.md) - required: true - - label: Be aware that json-editor-vue is only a Vue wrapper for [svelte-jsoneditor](https://github.com/josdejong/svelte-jsoneditor) - required: true - - label: Have a try at the latest version - required: true - - label: Search to see if your issue already exists - required: true - - label: Look for / ask questions on [Stack Overflow](https://stackoverflow.com/questions/ask) - required: false - - type: textarea - id: problem-description - attributes: - label: What problem does this feature solve? - description: | - Explain your use case, context, and rationale behind this feature request. More importantly, what is the **end user experience** you are trying to build that led to the need for this feature? - placeholder: Problem description - validations: - required: true - - type: textarea - id: proposed-API - attributes: - label: What does the proposed API look like? - description: | - Describe how you propose to solve the problem and provide code samples of how the API would work once implemented. Note that you can use [Markdown](https://guides.github.com/features/mastering-markdown/) to format your code blocks. - placeholder: Steps to reproduce - validations: - required: true diff --git a/.github/bug-repro-guidelines.md b/.github/bug-repro-guidelines.md deleted file mode 100644 index a9455b6..0000000 --- a/.github/bug-repro-guidelines.md +++ /dev/null @@ -1,29 +0,0 @@ -## About Bug Reproductions - -A bug reproduction is a piece of code that can run and demonstrate how a bug can happen。 - -### Text is not enough - -It's impossible to fix a bug from mere text descriptions。First，it's very difficult to precisely describe a technical problem while keeping it easy to follow；Second，the real cause may very well be something that you forgot to even mention。A reproduction is the only way that can reliably help us understand what is going on，so please provide one。 - -### A repro must be runnable - -Screenshots or videos are NOT reproductions！They only show that the bug exists，but do not provide enough information on why it happens。Only runnable code provides the most complete context and allows us to properly debug the scenario。That said，in some cases videos/gifs can help explain interaction issues that are hard to describe in text。 - -### A repro should be minimal - -Some users would give us a link to a real project and hope we can help them figure out what is wrong。We generally do not accept such requests because： - -You are already familiar with your codebase，but we are not。It is extremely time-consuming to hunt a bug in a big and unfamiliar codebase。 - -The problematic behavior may very well be caused by your code rather than by a bug in json-editor-vue。 - -A minimal reproduction means it demonstrates the bug，and the bug only。It should only contain the bare minimum amount of code that can reliably cause the bug。Try your best to get rid of anything that aren't directly related to the problem。 - -### How to create a repro - -For Vue 3 core reproductions，try reproducing it in [The SFC Playground](https://sfc.vuejs.org/)。 - -If it cannot be reproduced in the playground and requires a proper build setup，try [StackBlitz](https://vite.new/vue)。 - -If neither of these are suitable，you can always provide a GitHub repository。