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

Revise issue template #2201

Merged
merged 1 commit into from
Nov 30, 2017
Merged

Revise issue template #2201

merged 1 commit into from
Nov 30, 2017

Conversation

HebaruSan
Copy link
Member

Monitoring the new issue queue, a few patterns are apparent. There are some questions we don't ask in the issue template that we should, as well as some questions that don't generally receive productive responses. And a lot of people don't delete the instructional text at the top.

This pull request modifies the issue template:

  • Put the introductory text in a comment since it's not needed after the issue is submitted
  • Added link to where you can do a search of open issues
  • Split into background/problem sections
  • Added space between questions to encourage more consistent formatting 🤞
  • Added question about KSP version since many issues are version-specific
  • Added question about manual modifications to GameData since this is a frequent cause of issues
  • "Issue you are experiencing" and "How to recreate" replaced by steps taken, expected result, and actual outcome
  • Added screenshots section with instructional comment in case the reader doesn't know how

@HebaruSan HebaruSan added Documentation Issues affecting documentation Pull request labels Nov 29, 2017
@Olympic1
Copy link
Member

Oh, didn't know that you could add comments to the template.

@Olympic1 Olympic1 merged commit c4f2461 into master Nov 30, 2017
Olympic1 added a commit that referenced this pull request Nov 30, 2017
@HebaruSan HebaruSan deleted the HebaruSan-patch-issue-template branch November 30, 2017 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues affecting documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants