Skip to content

Commit

Permalink
update issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
leepc12 authored Sep 10, 2020
1 parent b33c8c6 commit c0f9ce7
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,34 @@ assignees: ''

---

**Describe the bug**
## **Describe the bug**
A clear and concise description of what the problem is.

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

**Caper configuration file**
## **Caper configuration file**
Paste contents of `~/.caper/default.conf`.
```ini
PASTE CAPER CONF CONTENTS HERE
```

**Input JSON file**
## **Input JSON file**
Paste contents of your input JSON file.
```json
PASTE INPUT JSON CONTENTS HERE
```

## **Troubleshooting result**

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.

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]`.

**Error log**
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.
Paste troubleshooting result.
```
$ caper debug [WORKFLOW_ID_OR_METADATA_JSON_FILE]
PASTE TROUBLESHOOTING RESULT HERE
```

0 comments on commit c0f9ce7

Please sign in to comment.