Skip to content

Commit c0f9ce7

Browse files
authored
update issue template
1 parent b33c8c6 commit c0f9ce7

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,34 @@ assignees: ''
77

88
---
99

10-
**Describe the bug**
10+
## **Describe the bug**
1111
A clear and concise description of what the problem is.
1212

13-
**OS/Platform**
14-
- OS/Platform: [e.g. Ubuntu 16.04, Google Cloud, Stanford Sherlock/SCG cluster, ...]
13+
## **OS/Platform**
14+
- OS/Platform: [e.g. Ubuntu 18.04, Google Cloud, Stanford Sherlock/SCG cluster, ...]
1515
- Conda version: If you used Conda (`$ conda --version`).
16-
- Pipeline version: [e.g. v1.3.3]
17-
- Caper version: [e.g. v0.6.0]
16+
- Pipeline version: [e.g. v1.6.0]
17+
- Caper version: [e.g. v1.2.0]
1818

19-
**Caper configuration file**
19+
## **Caper configuration file**
2020
Paste contents of `~/.caper/default.conf`.
21+
```ini
22+
PASTE CAPER CONF CONTENTS HERE
23+
```
2124

22-
**Input JSON file**
25+
## **Input JSON file**
2326
Paste contents of your input JSON file.
27+
```json
28+
PASTE INPUT JSON CONTENTS HERE
29+
```
30+
31+
## **Troubleshooting result**
32+
33+
If you ran `caper run` without Caper server then Caper automatically runs a troubleshooter for failed workflows. Find troubleshooting result in the bottom of Caper's screen log.
34+
35+
If you ran `caper submit` with a running Caper server then first find your workflow ID (1st column) with `caper list` and run `caper debug [WORKFLOW_ID]`.
2436

25-
**Error log**
26-
Caper automatically runs a troubleshooter for failed workflows. If it doesn't then get a `WORKFLOW_ID` of your failed workflow with `caper list` or directly use a `metadata.json` file on Caper's output directory.
37+
Paste troubleshooting result.
2738
```
28-
$ caper debug [WORKFLOW_ID_OR_METADATA_JSON_FILE]
39+
PASTE TROUBLESHOOTING RESULT HERE
2940
```

0 commit comments

Comments
 (0)