Skip to content

Commit

Permalink
update bug report
Browse files Browse the repository at this point in the history
  • Loading branch information
semuadmin committed Oct 27, 2024
1 parent 6633e0a commit a057145
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: pyspartn bug report
name: pyspartn Bug Report

about: Create a report to help us improve

Expand All @@ -10,39 +10,41 @@ labels: ''
assignees: semuadmin

---
# pyspartn Bug Report Template

**NB**: Please raise any general queries in the [pyspartn Discussions Channels](https://github.com/semuconsulting/pyspartn/discussions) in the first instance.

**Describe the bug**

A clear and concise description of what the bug is.
A clear and concise description of what the bug is. Please include:

Please specify the pyspartn version (`>>> pyspartn.version`) and, where possible, include:
- The **complete** Python script.
- The error message and full traceback.
- A binary / hexadecimal dump of the SPARTN data stream (e.g. from PuTTY, screen or u-center).
1. The pyspartn version (`>>> pyspartn.version`).
2. The **complete** Python script. Embed your code here (please do *NOT* attach *.py, *.zip, *.tgz or other executable / zipped files) ...
```python
your code here
```
3. The error message and full traceback.
4. The SPARTN data source (e.g. MQTT, L-Band or NTRIP server) and if possible a binary / hexadecimal dump of the raw SPARTN data stream.

**To Reproduce**

Steps to reproduce the behaviour:
1. Any relevant device configuration (if other than factory defaults).
2. Any causal command input(s).
2. Any causal UBX command input(s).

**Expected Behaviour**

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

**Desktop (please complete the following information):**

- The operating system you're using [e.g. Windows 11, MacOS Sequoia, Ubuntu Noble]
- The type of serial connection [e.g. USB, UART1]

**SPARTN data source (please complete the following information as best you can):**
- The operating system you're using [e.g. Windows 11, MacOS Sequoia, Ubuntu Noble].
- The type of serial connection [e.g. USB, UART1, I2C].

- e.g. Thingstream PointPerfect MQTT 100H
**GNSS/GPS Device (please complete the following information as best you can):**

(NB: Please redact any current SPARTN decryption keys)
- Device Model/Generation: [e.g. u-blox NEO-9M].
- Firmware Version: [e.g. SPG 4.03].
- Protocol: [e.g. 32.00].

This information is typically output by the device at startup via a series of NMEA TXT messages. It can also be found by polling the device with a UBX MON-VER message. If you're using the PyGPSClient GUI, a screenshot of the UBXConfig window should suffice.

**Additional context**

Expand Down

0 comments on commit a057145

Please sign in to comment.