Skip to content

Commit 14f38dc

Browse files
authored
github: update issue templates (tensorflow#2178)
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
1 parent 6bc1ff2 commit 14f38dc

File tree

4 files changed

+82
-15
lines changed

4 files changed

+82
-15
lines changed

.github/ISSUE_TEMPLATE.md

-15
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Bug report
3+
about: Report a problem in TensorBoard
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
Consider Stack Overflow for getting support using TensorBoard—they have
11+
a larger community with better searchability:
12+
13+
https://stackoverflow.com/questions/tagged/tensorboard
14+
15+
Do not use this template for for setup, installation, or configuration
16+
issues. Instead, use the “installation problem” issue template:
17+
18+
https://github.com/tensorflow/tensorboard/issues/new?template=installation_problem.md
19+
20+
To report a problem with TensorBoard itself, please fill out the
21+
remainder of this template.
22+
23+
## Environment information (required)
24+
25+
Please run `diagnose_tensorboard.py` (link below) in the same
26+
environment from which you normally run TensorFlow/TensorBoard, and
27+
paste the output here:
28+
29+
https://raw.githubusercontent.com/tensorflow/tensorboard/master/tensorboard/tools/diagnose_tensorboard.py
30+
31+
For browser-related issues, please additionally specify:
32+
33+
- Browser type and version (e.g., Chrome 64.0.3282.140):
34+
- Screenshot, if it’s a visual issue:
35+
36+
## Issue description
37+
38+
Please describe the bug as clearly as possible. How can we reproduce the
39+
problem without additional resources (including external data files and
40+
proprietary Python modules)?
+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Feature request
3+
about: Suggest an enhancement to TensorBoard
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
Please describe the problem that you’re facing and the enhancements that
11+
you’d like to see. Feel free to include screenshots or code samples.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Installation problem
3+
about: Report a problem installing or starting TensorBoard
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
Use this template if you have a problem building, installing,
11+
configuring, or starting TensorBoard and you suspect that there is a
12+
problem with TensorBoard itself.
13+
14+
Consider first reaching out to Stack Overflow for support—they have a
15+
larger community with better searchability:
16+
17+
https://stackoverflow.com/questions/tagged/tensorboard
18+
19+
## Environment information (required)
20+
21+
Please run `diagnose_tensorboard.py` (link below) in the same
22+
environment from which you normally run TensorFlow/TensorBoard, and
23+
paste the output here:
24+
25+
https://raw.githubusercontent.com/tensorflow/tensorboard/master/tensorboard/tools/diagnose_tensorboard.py
26+
27+
## Steps to reproduce (required)
28+
29+
Please provide explicit commands to reproduce the problem in a fresh
30+
environment (virtualenv, Conda environment, …). Include any necessary
31+
configuration, such as Conda `environment.yml` files.

0 commit comments

Comments
 (0)