Skip to content

Commit

Permalink
udpate ISSUE_TEMPLATE
Browse files Browse the repository at this point in the history
  • Loading branch information
gnzsnz committed May 18, 2024
1 parent 2534d85 commit ccb2dd1
Showing 1 changed file with 37 additions and 4 deletions.
41 changes: 37 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,43 @@
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
labels: ''
assignees: ''

---

## Before you submit this issue

If this is not an issue but a request for help, please post it on the
[discussions](https://github.com/gnzsnz/ib-gateway-docker/discussions/categories/q-a)
section. There is a search function that will help you find solutions to common
problems.

Please make sure that you are running `latest` or `stable` for either
`ib-gateway` or `tws-rdesktop`. Please run one of these as required

```bash
# ib-gateway
docker pull ghcr.io/gnzsnz/ib-gateway:latest
docker pull ghcr.io/gnzsnz/ib-gateway:stable
# tws-rdesktop
docker pull ghcr.io/gnzsnz/tws-rdesktop:latest
docker pull ghcr.io/gnzsnz/tws-rdesktop:stable
```

Please make sure that you are using the `docker-compose.yml` file provided as
example, those files are tested and you should be able to get things working
by using it.

- [ib-gateway](https://github.com/gnzsnz/ib-gateway-docker/blob/master/docker-compose.yml)
- [tws-rdesktop](https://github.com/gnzsnz/ib-gateway-docker/blob/master/tws-docker-compose.yml)

The example `.env` file on [README.md](https://github.com/gnzsnz/ib-gateway-docker/blob/master/README.md)
contains safe default values. Make sure you test the container using it as
starting point.

If after all this work you are still facing problems, please open an issue.

## Describe the bug

A clear and concise description of what the bug is.
Expand All @@ -16,7 +48,7 @@ A clear and concise description of what the bug is.
Steps to reproduce the behavior. Please include information related to docker,
ex docker run command, .env file, docker-compose.yml.

Please provide the output of `docker compose config`
Please provide the output of `docker compose config` **MANDATORY** ⚠️⚠️

## Expected

Expand All @@ -25,7 +57,7 @@ A clear and concise description of what you expected to happen.
## Container logs

If applicable, add the container logs `docker logs <CONTAINER>` or
`docker-compose logs` to help explain your problem.
`docker compose logs` to help explain your problem. **MANDATORY** ⚠️⚠️

## Versions

Expand All @@ -34,9 +66,10 @@ Please complete the following information:
- OS: [e.g. Windows]
- Docker version: [e.g. chrome, safari]
- Image Tag (`docker image inspect ghcr.io/gnzsnz/ib-gateway:tag`): [e.g.
latest]
latest, stable] **MANDATORY** ⚠️⚠️
- Image Digest (`docker images --digests`): [e.g.
sha256:60d9d54009b1b66908bbca1ebf5b8a03a39fe0cb35c2ab4023f6e41b55d17894]
**MANDATORY** ⚠️⚠️

## Additional context

Expand Down

0 comments on commit ccb2dd1

Please sign in to comment.