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

GitHub: add issue templates #201

Merged
merged 1 commit into from
Mar 10, 2021
Merged

GitHub: add issue templates #201

merged 1 commit into from
Mar 10, 2021

Conversation

guggero
Copy link
Member

@guggero guggero commented Mar 9, 2021

To make initial triage easier and nudge people into reading the documentation and gathering information before submitting an issue, we add three issue templates: bug reports, feature requests and "other".

@guggero
Copy link
Member Author

guggero commented Mar 9, 2021

A preview of how this looks (from Faraday):

github-issues

Copy link
Member

@jamaljsr jamaljsr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea 🥇

I just left a few nits. Nothing major.

.github/ISSUE_TEMPLATE/config.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/other.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.md Outdated Show resolved Hide resolved
name: Bug report
about: Create a report to help us improve
title: ''
labels: Bug
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be "bug" to match the one pre-created by GitHub? I think they are case-sensitive.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, this very likely is case sensitive. Fixed.

Copy link
Contributor

@justinpobrien justinpobrien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Nice work and great idea. Especially pointing folks to relevant resources.

@guggero guggero merged commit b581952 into master Mar 10, 2021
@guggero guggero deleted the issue-template branch March 10, 2021 18:53
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.

3 participants