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: update issue templates #2178

Merged
merged 3 commits into from
May 21, 2019

Conversation

wchargin
Copy link
Contributor

@wchargin wchargin commented May 2, 2019

Summary:
This commit adds issue templates for bug reports, feature requests, and
installation problems, with specific instructions for each.

This also resolves the nag from GitHub to move to the new issue template
workflow.

I created these by following the “issue template wizard” described here:
https://help.github.com/en/articles/creating-issue-templates-for-your-repository

Test Plan:
I’ve committed this to the default branch of my fork. Try drafting an
issue there: https://github.com/wchargin/tensorboard/issues/.

wchargin-branch: github-issue-templates

Summary:
This commit adds issue templates for bug reports, feature requests, and
installation problems, with specific instructions for each.

This also resolves the nag from GitHub to move to the new issue template
workflow.

I created these by following the “issue template wizard” described here:
<https://help.github.com/en/articles/creating-issue-templates-for-your-repository>

Test Plan:
I’ve committed this to the default branch of my fork. Try drafting an
issue there: <https://github.com/wchargin/tensorboard/issues/>.

wchargin-branch: github-issue-templates
@wchargin wchargin requested a review from manivaradarajan May 2, 2019 18:25
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/installation_problem.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/installation_problem.md Outdated Show resolved Hide resolved
wchargin added 2 commits May 16, 2019 13:55
wchargin-branch: issue-templates
Summary:
These aren’t strictly valid Markdown links, but this text primarily
appears in an editable, non-Markdown text box, and autolinks are a bit
easier to copy and paste.

wchargin-branch: issue-templates
Copy link
Contributor Author

@wchargin wchargin left a comment

Choose a reason for hiding this comment

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

Addressed. You’re mostly right, I think. I’ve offloaded most of the
environment work to diagnose_tensorboard.py (#2237), and made the
“steps to reproduce” wordings more lenient.

Copy link
Contributor

@nfelt nfelt left a comment

Choose a reason for hiding this comment

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

In general I think this is an improvement, but it feels a little heavyweight to ask users to download a script to collect data even if tensorboard mostly works rather than just building that functionality into TensorBoard itself. (For installation problems, of course, that's the best we can do.)

Maybe we could put this script in the pip package somewhere and just add a tensorboard --diagnose option that invokes it? That way it seems a little less annoying for the user.

Edited to add: ok, so a downside is that they wouldn't get the latest version of the diagnose script. I guess that might be a good reason to stick with this approach, though I still wish we could smooth it out a little.

@wchargin
Copy link
Contributor Author

Edited to add: ok, so a downside is that they wouldn't get the latest
version of the diagnose script.

Right, that was my thinking. It’d be a one-line change to setup.py if
we wanted to provide a diagnose_tensorboard binary, but we couldn’t
keep that up to date with checks and suggestions.

I’ll merge this PR as is, and would be happy to consider further
improvements to the delivery.

@wchargin wchargin merged commit 14f38dc into tensorflow:master May 21, 2019
@wchargin wchargin deleted the wchargin-issue-templates branch May 21, 2019 00:32
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.

2 participants