Allow the “Raise issue” button to use a GitHub issue template or issue form #8117
chphr
started this conversation in
Feature Requests
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
The “Raise issue” button always opens GitHub’s blank issue editor with the page path written into the issue body. There’s no way to point it at an issue template or issue form. Repositories that use issue forms to collect structured feedback can’t use the button as intended without a bandaid JavaScript workaround.
Current behavior
Clicking “Raise issue” opens github.com///issues/new with a prefilled title and a body containing the page path. GitHub ignores the repository’s issue templates for this kind of link, so the reader gets an unstructured blank issue.
The problem
We maintain a public docs repository and use a GitHub issue form to collect documentation feedback. The form asks for the page, issue type, platform, and description, and it shows a warning not to share sensitive information, which matters for a public repo. Because of the button’s current behavior:
Feedback from the button arrives unstructured and skips the fields and warnings in our form.
Proposed solution
Add an option to configure the issue link, for example in docs.json (or via the project settings/GitHub app):
json
With this set, the button would link to:
https://github.com/<org>/<repo>/issues/new?template=docs-issue.yml&path=<page URL>GitHub issue forms already support filling in fields from URL parameters that match field ids, so pathField would let the page URL land in the right field. If template isn’t set, the button would work as it does today, so existing setups wouldn’t be affected.
Optional additions would also help: a configurable title format, and labels passed through the labels parameter.
Why it matters
Structured issues are much faster to triage, and issue forms are now the standard way GitHub repositories collect feedback. Supporting them would make the button useful for teams that rely on forms, and it would remove the need for fragile workarounds like ours.
All reactions