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

Improve GH issue template #94

Merged
merged 2 commits into from Jan 17, 2020

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Dec 17, 2019

Proposed Changes

Improve GH issue template

Add some additional guidance in an attempt to make sure that enough information will be added to issues to make them actionable.

Move the issue template

Having a singular issue template named .github/ISSUE_TEMPLATE.md is using the legacy workflow from GitHub.
GitHub nowadays recommends for issue templates to be placed in a ISSUE_TEMPLATE directory and to use front matter, to allow for multiple descriptive issue templates.

Ref: https://help.github.com/en/github/building-a-strong-community/about-issue-and-pull-request-templates

Add some additional guidance in an attempt to make sure that enough information will be added to issues to make them actionable.
Having a singular issue template named `.github/ISSUE_TEMPLATE.md` is using the legacy workflow from GitHub.
GitHub nowadays recommends for issue templates to be placed in a `ISSUE_TEMPLATE` directory and use front matter, to allow for multiple descriptive issue templates.
@jrfnl jrfnl force-pushed the feature/github-issue-template-request-more-info branch from 55f226a to b33c868 Compare December 17, 2019 04:58
Copy link
Member

@Potherca Potherca left a comment

Choose a reason for hiding this comment

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

Looks good, merging.

@Potherca Potherca merged commit 2510f68 into master Jan 17, 2020
@jrfnl jrfnl deleted the feature/github-issue-template-request-more-info branch January 17, 2020 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants