Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue forms #1166

Merged
merged 4 commits into from Jul 20, 2021
Merged

Issue forms #1166

merged 4 commits into from Jul 20, 2021

Conversation

sagikazarmark
Copy link
Contributor

@sagikazarmark sagikazarmark commented Jul 20, 2021

This PR demonstrates a couple other options for issues provided by GitHub:

An alternative to the markdown issue templates is using issue forms. It's a nice way to make bug reports more sophisticated (eg. make sure to include a version field).

This PR converts the current markdown templates to issue forms. Preview:

It also adds a couple links to the issue opening page offering additional help: https://github.com/sagikazarmark/kit/blob/issue-forms/.github/ISSUE_TEMPLATE/config.yml

TBH, issue forms is not necessarily better for the current templates, because they are quite simple.

A couple examples from other projects:

Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>
Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>
Copy link
Member

@peterbourgon peterbourgon left a comment

Oh yeah, didn't know about this. Nice!

.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.yaml Outdated Show resolved Hide resolved
sagikazarmark and others added 2 commits Jul 20, 2021
Co-authored-by: Peter Bourgon <peterbourgon@users.noreply.github.com>
@sagikazarmark sagikazarmark merged commit 8b2c52a into go-kit:master Jul 20, 2021
2 checks passed
@sagikazarmark sagikazarmark deleted the issue-forms branch Jul 20, 2021
@sagikazarmark
Copy link
Contributor Author

sagikazarmark commented Jul 20, 2021

@peterbourgon apparently contact links don't work without an about text. :\ What would you like me to do?

@peterbourgon
Copy link
Member

peterbourgon commented Jul 20, 2021

Dumb. Just put them back I guess.

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.

None yet

2 participants