Skip to content

Commit

Permalink
EE-1778: Create a bug report template
Browse files Browse the repository at this point in the history
Created Bug_report template and fix a typo in the README.md
  • Loading branch information
M-casado authored Jan 14, 2021
2 parents ce44346 + 969d8f1 commit 911975f
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 1 deletion.
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
name: Bug report
about: Create a report to help us fix an issue you experienced.
labels: bug

---

**Title of the bug**

*(e.g. Error with `--delete-temp-files`)*

**Description of the bug**

A clear and concise description of what the bug is.

*(e.g. Used option `--delete-temp-files` did not delete all temporary files after failed transfer)*

**Used versions** (please complete the following information)
- Operating System version:             *(e.g. `Windows 10.0.19041`)*
- Python version:                              *(e.g `3.7.0`)*
- PyEGA3 version:                             *(e.g `EGA python client version 3.4.0`)*
- Please, **confirm you have tested your PyEGA3 installation** (follow [instructions](https://github.com/EGA-archive/ega-download-client#testing-pyega3-installation#Testing-pyEGA3-installation)):

Before creating a bug report, you may want to check if your issue is displayed in the [Troubleshooting](https://github.com/EGA-archive/ega-download-client#Troubleshooting). If the version of PyEGA3 you are using is not the most recent one, we strongly recommend updating PyEGA3 (follow instructions at [Installation and update](https://github.com/EGA-archive/ega-download-client#Installation-and-update)) and checking if the bug still appears.

**To Reproduce**

Steps to reproduce the behaviour that led you to the bug.

*e.g.:*
1. Trying to download BAM file `EGAF00001753754`.
```
pyega3 fetch -cf ./CREDENTIALS_FILE.json --format BAM --delete-temp-files --saveto ./Output/ EGAF00001775036
```
2. After 1 minute, interrupt transfer by exiting the terminal.
3. Check for temporary files.

**Observed behaviour**

A clear and concise description of what happened.

*(e.g. Temporary files remain after failed transfer)*

**Expected behaviour**

A clear and concise description of what you expected to happen.

*(e.g. Temporary files should be removed after failed transfer)*

**Screenshots and error messages**

If applicable, add screenshots or any error message (both printed to the terminal or to the `pyega3_output.log` log file) to help explain your problem.

**Additional context**

Add any other context about the problem here.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ usage: pyega3 fetch [-h] [--reference-name REFERENCE_NAME]
[--reference-md5 REFERENCE_MD5] [--start START]
[--end END] [--format {BAM,CRAM}]
[--max-retries MAX_RETRIES] [--retry-wait RETRY_WAIT]
[--saveto [SAVETO]]
[--saveto [SAVETO]] [--delete-temp-files]
identifier
positional arguments:
Expand Down

0 comments on commit 911975f

Please sign in to comment.