kerhub / issue-forms-creator

GitHub Issue Forms generator

build Issue Forms with forms with ease

Issue Forms Creator is a generator for the Github Issue Forms feature. Rather than typing your own yaml file, fill a form and copy the yaml version.

Benefits :

• ✅ less prone errors
• ✅ expose the all available options
• ✅ live preview
• ✅ drag and drop support to sort your content
• ✅ bug/feature request starters
• ✅ yaml import support
• ✅ use most of the validations made by Github
• ✅ load an existing repo to retrieve labels and contributors

Usage

• (optional) load your repository to retrieve labels and contributors
• add and fill fields
• copy the yaml file
• create a .yml file into the .github/ISSUE_TEMPLATE folder
• paste the copied content into this new file
• commit the changes

Developer

You will find guidelines to run the project here

Contributing

Read through our contributing guidelines to learn about our submission process, coding rules and more.

Ui Component Library

The UI Component Library is built with Storybook and deployed here.

issue-forms-creator's Issues

[Bug]: checkboxes with required field are no longer valid

Description

When generating a section with the checkboxes type, and selecting required: true, it will generate YAML that no longer correctly matches the Github issue-forms syntax.

Minimal Reproduction

1. Go to https://issue-forms-creator.app/new
2. Create a checkboxes type
3. Create a new checkbox, and make that checkbox required: true.
4. Generate YAML, and try and use within Github.
5. You should receive an error stating that the YAML is not valid.

This is what gets generated, as an example:

[...]
  - type: checkboxes
    id: requirements
    attributes:
      label: Requirements
      description: "Please confirm the following:"
      options:
        - label: >-
            I have confirmed that someone else has not submitted a similar
            bug report.
          validations:
            required: true

This is what should be generated:

[...]
  - type: checkboxes
    id: requirements
    attributes:
      label: Requirements
      description: "Please confirm the following:"
      options:
        - label: >-
            I have confirmed that someone else has not submitted a similar
            bug report.
          required: true

Exception or Error

No response

[Bug]:

Description

When I input a valid GitHub Repo URL, it says it is invalid. I am inputting https://github.com/3kh0/3kh0.github.io but it says invalid.

Minimal Reproduction

Input https://github.com/3kh0/3kh0.github.io into the Github repository url field

Exception or Error

[Bug]: Outdated, no longer working?

Description

Hi there, I think GitHub may have changed their template styles and this generator no longer works. Although this may be a GitHub bug?

I see that this generator creates templates such as this...

but when I insert that, GitHub doesn't pick it up (I used Bug Report)

When I added the -- above and below the header like so..

then I got this warning...

so I changed "description" to "about", but then it still doesn't pick up the rest of it in the new template...

The weird thing is, your syntax matches here:
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms

Maybe I'm missing something or there's a GitHub bug with my repo?

Minimal Reproduction

No response

Exception or Error

No response

[Bug]: assignee can't be removed once added

Description

After adding an assignee using the form builder, if you then remove that assignee, they aren't actually removed (both in the UI, and when you generate the YAML).

Minimal Reproduction

1. Go to https://issue-forms-creator.app/new
2. Add a random user
3. Remove the random user
4. see right side, user still exists
5. Generate YAML, and inspect for the assignee field still being populated.

Exception or Error

No response

[Bug]: Loading template does not work

Description

Loading any template (also pasting from YAML) does not work for me.
See below for a MRE.

Minimal Reproduction

I am using the following MRE:

name: Bug report
description: Create a bug report to help us improve
title: '[Bug]: '
body:
  - type: textarea
    attributes:
      label: Description
      description: Hello
      placeholder: Trying to load anything
    validations:
      required: true

Exception or Error

No response

[Bug]: Jest failing after Angular 14 update: Cannot find module '@angular/core/testing'

Description

Error log after updating to Angular 14 with ng update @angular/core@14 @angular/cli@14 command and running ng test one:

Cannot find module '@angular/core/testing' from 'node_modules/jest-preset-angular/build/config/setup-jest.js'

    Require stack:
      node_modules/jest-preset-angular/build/config/setup-jest.js
      node_modules/jest-preset-angular/setup-jest.js
      node_modules/@angular-builders/jest/dist/jest-config/setup.js

      at Resolver.resolveModule (node_modules/jest-resolve/build/resolver.js:324:11)

Minimal Reproduction

run ng test

Exception or Error

Cannot find module '@angular/core/testing' from 'node_modules/jest-preset-angular/build/config/setup-jest.js'

    Require stack:
      node_modules/jest-preset-angular/build/config/setup-jest.js
      node_modules/jest-preset-angular/setup-jest.js
      node_modules/@angular-builders/jest/dist/jest-config/setup.js

      at Resolver.resolveModule (node_modules/jest-resolve/build/resolver.js:324:11)

[Bug]: npm install failed

Description

Directly after installing node.js on my recently installed Windows 11 machine, I navigated to the issue-forms-creator folder where I cloned your project. There I used npm install and got the errors below. Some dependencies don't work now?

Minimal Reproduction

Tried again, same result

Exception or Error

PS C:\EncounterPro\angular\issue-forms-creator> npm install
npm ERR! code ERESOLVE
npm ERR! ERESOLVE could not resolve
npm ERR!
npm ERR! While resolving: @angular-eslint/[email protected]
npm ERR! Found: @angular/[email protected]
npm ERR! node_modules/@angular/cli
npm ERR! dev @angular/cli@"^14.2.6" from the root project
npm ERR! peerOptional @angular/cli@">=6.0.0" from @storybook/[email protected]
npm ERR! node_modules/@storybook/angular
npm ERR! dev @storybook/angular@"^6.5.12" from the root project
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer @angular/cli@">= 13.0.0 < 14.0.0" from @angular-eslint/[email protected]
npm ERR! node_modules/@angular-eslint/schematics
npm ERR! dev @angular-eslint/schematics@"13.2.1" from the root project
npm ERR!
npm ERR! Conflicting peer dependency: @angular/[email protected]
npm ERR! node_modules/@angular/cli
npm ERR! peer @angular/cli@">= 13.0.0 < 14.0.0" from @angular-eslint/[email protected]
npm ERR! node_modules/@angular-eslint/schematics
npm ERR! dev @angular-eslint/schematics@"13.2.1" from the root project
npm ERR!
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR!
npm ERR!
npm ERR! For a full report see:
npm ERR! C:\Users\Somebody\AppData\Local\npm-cache_logs\2023-06-17T03_43_17_725Z-eresolve-report.txt

npm ERR! A complete log of this run can be found in:
npm ERR! C:\Users\Somebody\AppData\Local\npm-cache_logs\2023-06-17T03_43_17_725Z-debug-0.log

[Bug]: label field not working

Description

When we make any new form. The label field in the issue header is not working as expected.

Minimal Reproduction

Just make a new form and try adding label to the form. It will not add. Not in preview and not in copied yaml code.

Exception or Error

No errors.