Feedback Wanted: Issue Forms beta and Issue Templates #63402
Replies: 49 comments 32 replies
-
Hello, I'm very happy that GitHub plans to improve issue forms. One main missing element is a preview to render and validate syntax when you are creating a form 1 2. Some input field types can be really useful:
And custom validation (ex: regex) can be a good thing 5. Some textarea can contain large content (ex: logs, code examples, ...), and being able to wrap them into A very important element for me is conditional sections: being able to show/hide a form item based on a previous choice 7 8. In the same scope, a user-editable "other" field in dropdown can simplify the use of form 9. Also being able to add details/descriptions to dropdown items can help users to understand the items. The forms are very useful for issues, but they can also be really useful for pull requests 10. Bonus: gets issue form data via API to facilitate automation 11. Not sure if you expect this kind of feedback. Footnotes |
Beta Was this translation helpful? Give feedback.
-
Definitely some kind of rich web UI (WYSIWYG) to create/edit/preview[1] issue forms would be immensely useful. Similar to setting up issue templates, there could be an option to set up issue forms in a visual manner. Like, click "Add" and pick the control from a drop down list (e.g. "Text Area"); drag the controls to reorder, and have all the configurable options to the side (description, placeholder, value). Sort of like a form designer (MS Access, Visual Basic) which saves a perfect YAML! Nothing's wrong with the current documentation on the side (which I just discovered if I use the web UI, did not know that! I admit I haven't used this feature much). Being quite visual and eager to see what the user interacts with (and test input/output), the current YAML approach seems a little daunting to set up for many repositories, so the issue template wins for now. It could open doors to this suggestion whereby having a design view would make it easier to visualise logic for something like conditional fields. +1 for a URL and file ("drag and drop here!") inputs. |
Beta Was this translation helpful? Give feedback.
-
It doesn't seem like the Edit: Also, it doesn't seem like the issue with |
Beta Was this translation helpful? Give feedback.
-
Thanks for the happy improvements on GitHub Issues and Projects! As indicated in this article, I would like to use the new configuration of the issue template that sets a project as default, but I can't do this with the configuration below. For example, our project's project URL is below.
Then I set the
Can you tell me some correct examples? |
Beta Was this translation helpful? Give feedback.
-
It'd be great if not only can you set the default project, but also other fields such as status and values for custom fields. |
Beta Was this translation helpful? Give feedback.
-
Hello, Thanks for the improvements to the issue forms ! As I have been using the forms in a private repo, there is a functionality which would be really useful : the ability to modify some issues metadata dynamically from the form. In particular, modifying labels and affected milestones from a checkbox or a dropdown would help my team tremendously. Something which may (roughly) look like this :
Even though you can set the labels in the sidebar, it can be useful to set them in distinct form sections. For instance, I could have a dropdown dedicated to components labels and a dropdown dedicated to priority (setting labels like P1, P2, P3, etc). It is faster to navigate the dropdown list than searching through the labels manually. EDIT : I also saw this proposal to give access to tags within the forms, this would also be a very practical field to have access to. |
Beta Was this translation helpful? Give feedback.
-
Thank you for the issue forms feature, it is really great so far! The most important things I'm missing right now are:
I elaborated on the first point already in a comment on the linked discussion. As for the second point, here are some details. I maintain a bunch of libraries, and lots of them use the same issue forms to report bugs, suggest features or doc improvements, etc. Most of them only differ in the repo name that is mentioned in some field labels or descriptions. I would love it if I could define an issue form template with inputs (like a GitHub action) in some repo, and then reference this issue form template from for other repositories in their For example, I could have an issue form template like this in some repo called
inputs:
repo_name:
required: true
template:
name: Bug report
description: File a bug report
labels: ["bug"]
body:
- type: markdown
attributes:
value: Thanks for taking the time to fill out this bug report!
- type: input
id: version
attributes:
label: Version of {{ inputs.repo_name }}
description: In which version of {{ inputs.repo_name }} did you experience the issue?
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: What happened?
placeholder: Incorrect behaviour, error message, stacktrace...
description: Please describe what you see and what you expected to happen instead
validations:
required: true And then from all repositories that want to use it, something like this (syntax borrowed from GitHub Actions):
blank_issues_enabled: true
forms:
- uses: joffrey-bion/my-templates/bug_report_template.yml@v3
with:
repo_name: this-repo
contact_links:
- name: Ask a question
about: For general usage questions, please use GitHub Discussions
url: https://github.com/joffrey-bion/krossbow/discussions |
Beta Was this translation helpful? Give feedback.
-
Does the new |
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
when I'm creating an issue in GitHub Projects, would be great if I could use a form template from the repository the issue is created in instead of having to click into the repository to add an issue from there. |
Beta Was this translation helpful? Give feedback.
-
The issue forms are working much better for us than the issue templates! It's great to be able to provide instructional text to folks without having to use HTML comments.
Overall I'm happy with the experience. While a visual form builder would be nice, I don't have a problem using the yml directly. I just run my file through a yml validator. The GitHub plugin for VS Code that can do validation on GitHub Actions is pretty useful, and maybe it can be enhanced to validate issue forms as well? |
Beta Was this translation helpful? Give feedback.
-
Started using this recently and so far it's been a very smooth workflow, the only things I'd like to see in the near future are:
|
Beta Was this translation helpful? Give feedback.
-
I just found out about issue forms this week and have been learning and experimenting with the added features for our repositories! Here is my feedback so far: 1. Form validation accessThe validations keys for each of the existing input field types (
PLEASE enable this feature for private repositories too! Limiting the option to set a field as required for only public repositories seems counter intuitive to many of us. Private repositories need form validation just as much as a public repository would. 2. Post-commit error messagesTrying to get past all the errors was tedious once I was past the more helpful Body[i]: required key type is missing error messages because I had no line, column or character references. Getting a Checkboxes must have unique labels error when I have many to check and the body:
- type: checkboxes
id: operating-systems
attributes:
label: Which operating systems have you used? # <-- field label
description: You may select more than one.
options:
- label: macOS # <-- options label
- label: Windows
- label: Linux
validations:
required: true # <--- good feature for public and private repositories 3. Feature request: Table/Matrix input typeI work in consumer electronics testing and we frequently have multiple physical products to record test results and issues for at the same time. Single line Something like this:
As the documentation and features evolve, please consider these improvements! Thank you for the awesome new way to template! |
Beta Was this translation helpful? Give feedback.
-
Bug: the |
Beta Was this translation helpful? Give feedback.
-
I've implemented issue forms for two projects so far. The biggest ask that I have (other than a way to visually preview the yaml on GitHub and ensure it validates / a visual issue form creator) would be more control over who can see certain forms and their items. Being able to restrict forms and fields to org members would be quite helpful! In leu of this being implemented, users have come up with hacky honor-based systems of restricting who can open issues which are lovely but not exactly the best user experience for all involved. ;) |
Beta Was this translation helpful? Give feedback.
-
I am interested in using issue forms but it is missing one feature for me. I would like to provide some input boxes for the user, but include extra markdown in the final issue that is not rendered in the form (at the end of the issue). Basically, I want to have the user input some basic data and then generate an issue with a detailed checklist in it. Bonus points if the issue markdown content can be a template that's filled in with the user input. |
Beta Was this translation helpful? Give feedback.
-
Is anyone @github reading this thread still? There has been stream of problems, issues and ideas, but no reaction whatsoever, not to mention basic bugs left without reaction. |
Beta Was this translation helpful? Give feedback.
-
When adding a link to file contained in the same repo, currently if relative path is used, like in Currently, one workaround is to use Perhaps some new configuration can be provided to setup the default root url for relative URLs used in issue and pull request templates. Another possibility is to allow using something similar to expressions and contexts in GitHub Actions. |
Beta Was this translation helpful? Give feedback.
-
I'd love to be able to use both the form and the MD template in combination. There should be some syntax ( Also: I'd love to use templates to streamline project management. To that end, templates should allow me to auto set the milestone and should be markable as "internal" templates (for contributors only) vs "external" templates (for outsiders looking to report issues). Please let me know if any of the above exists and I just missed it 😊🙏 |
Beta Was this translation helpful? Give feedback.
-
A roadmap entry for the forms feature and an approximate timeline for it to exit beta would be great! My organization prefers we don't use features which are in beta. |
Beta Was this translation helpful? Give feedback.
-
If I get it right, there is a missing feature: to create issue from URL parameters when it's using form schema. |
Beta Was this translation helpful? Give feedback.
-
@j0siepy or anyone @github Any chance to receive any feedback to issues reported here? |
Beta Was this translation helpful? Give feedback.
-
Hi @j0siepy, We've been using issue forms for a while now and we are quite happy with them, but there is one thing that is becoming increasingly annoying: the lack of truly optional We use a few ### {label}
_No response_ Here is a real world example### What's needed?
The error conditions that can arise for each type of request should be documented, as should the expected behavior of the server, including the expected response code.
### Proposed solution
_No response_
### Use cases
_No response_
### Alternatives and workarounds
_No response_
### Additional context
_No response_ It would be awesome is non-required - type: textarea
id: solution
attributes:
label: Proposed solution
description:
Please tell us how you think the needs above can be fulfilled. Only
fill this field if it wasn't described above.
placeholder:
How do you think the needs above can be fulfilled. Only fill this field
if it wasn't described above.
skip-if-empty: true So the resulting issue would just not have it at all. Here is how I would like my real world example to look like with this### What's needed?
The error conditions that can arise for each type of request should be documented, as should the expected behavior of the server, including the expected response code. Thanks! |
Beta Was this translation helpful? Give feedback.
-
Perhaps I overlooked this in the docs, but are there any plans to support conditional fields within issue forms? I'm particularly interested in a feature where additional fields are displayed to the user based on their selection in a dropdown menu. For instance: body:
- type: dropdown
id: version
attributes:
label: Time sensitive?
description: Does this issue need to be completed by a specific time?
options:
- true
- false
default: false
validations:
required: true If the user chooses |
Beta Was this translation helpful? Give feedback.
-
The facility to pass all field values, not just custom text fields, with a URL query. |
Beta Was this translation helpful? Give feedback.
-
The issue forms a great! Thanks for making these available! It would be super if they were also available for PRs to allow for more effective templating and automatic labeling there as well https://github.com/orgs/community/discussions/4881 |
Beta Was this translation helpful? Give feedback.
-
Yes, exactly. It appears I have found an issue which prevents issue forms from working at all. GitHub appears to be case-sensitive. If the directory is not called exactly ISSUE_TEMPLATE, in all capitals, then it simply won't work and the selector will not appear. |
Beta Was this translation helpful? Give feedback.
-
I really like having editable attributes in the form. We use checkboxes to indicate status of some things, but being able to have input boxes that can be filled out after creating the issue would be useful. |
Beta Was this translation helpful? Give feedback.
-
i like the issue forms. but, it would be really nice if it told you if there was an error BEFORE committing. i used 20-30 commits trying to fix errors |
Beta Was this translation helpful? Give feedback.
-
Extra input type for forms for only attache files
|
Beta Was this translation helpful? Give feedback.
-
📢 Calling all issue management aficionados! We're embarking on a mission to improve GitHub issue forms and templates, and would love to hear from you!
💡 Share your creative ideas and experiences in crafting issue forms and templates that have made issue triaging a breeze. What fields, labels, or instructions have you include to ensure comprehensive and clear issue reporting? Are there any features missing that would help optimize this process? We're looking to help maintainers and admins set up the perfect balance between gathering necessary information and keeping the issue creation user-friendly.
🔍 Imagine you have a magic wand to create the ultimate GitHub issue form/template creation and management experience. What tools have you used in the past that made this a breeze? What features would help you manage and track issues across repositories, organizations and projects?
🐞 Run into any bugs with issue forms and templates? Let us know!
🤝 Let's collaborate and design a streamlined, intuitive, and impactful Join the discussion below and let the magic of collaboration begin! ✨
Beta Was this translation helpful? Give feedback.
All reactions