Forms are Finally Here!!!

June 23, GitHub announced Issue Forms beta for public repositories. If you are a maintainer of an open-source project on GitHub, issues are the lifeblood of your project for your userbase to interact and report bugs and features. Discussions is also an option but most generally stick with using GitHub Issues.

GitHub uses YAML for GitHub Actions and various other features in repositories that let you define what you want in code rather than using a UI. Issue Forms uses this and a change from the markdown style that we use up to this point.

The use of Issue Forms allows you more control over what users can input on a specific issue. In the markdown style, all we can do is provide comments or suggestions, and as users submit them, we hope for the best. If you get many users that simply select all text and remove it, then your template serves no purpose. Issue Forms helps with all of this and gives you the control of at least asking them for specific details in a given text box, drop-down, or checkbox.

An example drop-down option, where you can also see the red * that means a selection has to be done before the issue can be submitted.

image

The only requirement for using this feature currently is the repository has to be public. I created a public repository, wsmelton/testing-issue-templates if you would like to see a few live and interact with them.

I’ve also implemented them for the following projects I am a maintainer for as well:

More Information

More details on the Issue Forms: