Skip to content

Conversation

patak-dev
Copy link
Member

Migrate to issues forms. See playground at https://github.com/patak-dev/vue-issues-forms

This PR doesn't change the descriptions of each field. We should remove references to Vue 2 bugs here, and maybe point users to StackBlitz instead of CodeSandbox. I can modify it, or feel free to change the texts before merging.

Differences with https://new-issue.vuejs.org equivalent using issues forms:

  • There aren't conditional fields. A project could create one .yml issue form for each language and issue type and let them users choose (in the same way they choose if something is a Bug Report or a Feature Request)

  • Instead of the version combo box, following how Vite bug reports works we are asking this info directly with the system info asking users to run envinfo in their projects

    npx envinfo --system --npmPackages vite,@vitejs/plugin-vue --binaries --browsers
    

    Note: A version combo box could be done by each repo editing the yml to add the tag during release in each project.

  • Issues Forms doesn't work on mobile (this could count as a feature, uses shouldn't use mobile to report an issue

  • In Vite issues we include a series of required checkboxes that users need to tick before being able to submit. For Vitepress for example they look like

    - type: checkboxes
      id: checkboxes
      attributes:
        label: Validations
        description: Before submitting the issue, please make sure you do the following
        options:
          - label: Follow our [Code of Conduct](https://vuejs.org/coc)
            required: true
          - label: Read the [docs](https://vitepress.vuejs.org/).
            required: true
          - label: Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
            required: true

    This is good to reinforce some checks that were described in the form description. The problem with these required checkboxes is that there isn't a way to avoid showing them in the final issue so the final issue is a bit more cluttered.

Copy link
Member

@posva posva left a comment

Choose a reason for hiding this comment

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

I think this is a good idea but I wonder if GitHub issues forms are still ready for us because they are lacking some i18n integration and a lot of our users use the Chinese version

required: true
- type: textarea
id: system-info
attributes:
Copy link
Member

Choose a reason for hiding this comment

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

I think this should be optional as it's not relevant for most issues in vue and it's annoying for users to do

@netlify
Copy link

netlify bot commented May 12, 2022

Deploy Preview for vue-sfc-playground ready!

Name Link
🔨 Latest commit d715a9d
🔍 Latest deploy log https://app.netlify.com/sites/vue-sfc-playground/deploys/627c63581f88f100087dd756
😎 Deploy Preview https://deploy-preview-5145--vue-sfc-playground.netlify.app/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@netlify
Copy link

netlify bot commented May 12, 2022

Deploy Preview for vuejs-coverage ready!

Name Link
🔨 Latest commit d715a9d
🔍 Latest deploy log https://app.netlify.com/sites/vuejs-coverage/deploys/627c63582801540008937830
😎 Deploy Preview https://deploy-preview-5145--vuejs-coverage.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@netlify
Copy link

netlify bot commented May 12, 2022

Deploy Preview for vue-next-template-explorer ready!

Name Link
🔨 Latest commit d715a9d
🔍 Latest deploy log https://app.netlify.com/sites/vue-next-template-explorer/deploys/627c6358f7c8bb0008048dd1
😎 Deploy Preview https://deploy-preview-5145--vue-next-template-explorer.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@yyx990803 yyx990803 merged commit cb69208 into vuejs:main May 12, 2022
iwusong pushed a commit to iwusong/core that referenced this pull request May 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants