|
1 | | -name: Bug report |
| 1 | +name: 🐛 Bug report |
2 | 2 | description: Report a defect in OpenMapX |
| 3 | +title: "[Bug]: " |
3 | 4 | labels: [bug, needs-triage] |
4 | 5 | body: |
5 | 6 | - type: markdown |
6 | 7 | attributes: |
7 | 8 | value: | |
8 | | - Thanks for the report. Please fill out as much as you can — incomplete reports get bounced. |
9 | | - For security issues, do **not** file a public issue; see [SECURITY.md](../blob/main/SECURITY.md). |
| 9 | + Thanks for taking the time to file a bug. Please fill out as much as you can — |
| 10 | + incomplete reports are slower to act on and may be closed. |
| 11 | +
|
| 12 | + - 🔒 **Security issue?** Do **not** file it here — see [SECURITY.md](https://github.com/OpenMapX/openmapx/blob/main/SECURITY.md). |
| 13 | + - ❓ **Question or idea?** Please use [Discussions](https://github.com/OpenMapX/openmapx/discussions) instead. |
| 14 | + - type: checkboxes |
| 15 | + id: preflight |
| 16 | + attributes: |
| 17 | + label: Before you start |
| 18 | + options: |
| 19 | + - label: I searched [existing issues](https://github.com/OpenMapX/openmapx/issues?q=is%3Aissue) and this isn't a duplicate. |
| 20 | + required: true |
| 21 | + - label: I'm on the latest `main` or the most recent release (older versions aren't patched). |
| 22 | + required: true |
| 23 | + - label: This is a bug in OpenMapX itself, not in an upstream service (Valhalla, Nominatim, MOTIS, …) or a third-party API. |
| 24 | + required: true |
10 | 25 | - type: textarea |
11 | 26 | id: what-happened |
12 | 27 | attributes: |
13 | 28 | label: What happened? |
14 | | - description: What did you do, what did you expect, what did you observe? |
| 29 | + description: A clear, concise description of the bug — what you expected and what actually occurred. |
| 30 | + validations: |
| 31 | + required: true |
| 32 | + - type: textarea |
| 33 | + id: repro |
| 34 | + attributes: |
| 35 | + label: Steps to reproduce |
15 | 36 | placeholder: | |
16 | | - Steps: |
17 | | - 1. |
18 | | - 2. |
19 | | - 3. |
20 | | - Expected: |
21 | | - Actual: |
| 37 | + 1. Go to '...' |
| 38 | + 2. Search for '...' / enable service '...' / run `openmapx ...` |
| 39 | + 3. See error |
22 | 40 | validations: |
23 | 41 | required: true |
24 | | - - type: input |
| 42 | + - type: dropdown |
| 43 | + id: where |
| 44 | + attributes: |
| 45 | + label: Where does it happen? |
| 46 | + options: |
| 47 | + - Self-hosted deployment (Docker Compose) |
| 48 | + - Local development (`pnpm dev`) |
| 49 | + - Hosted app (openmapx.com) |
| 50 | + - Not sure |
| 51 | + validations: |
| 52 | + required: true |
| 53 | + - type: dropdown |
25 | 54 | id: component |
26 | 55 | attributes: |
27 | | - label: Affected component |
28 | | - description: Which app, service, integration, or CLI command? |
29 | | - placeholder: "apps/web, integrations/transit-hafas, packages/cli `openmapx services up`, ..." |
| 56 | + label: Affected area |
| 57 | + description: Which part of OpenMapX? Pick the closest. |
| 58 | + options: |
| 59 | + - Web app (apps/web) |
| 60 | + - API gateway (apps/api) |
| 61 | + - Admin panel |
| 62 | + - A specific integration (integrations/*) |
| 63 | + - A specific service / container (services/*) |
| 64 | + - CLI (`openmapx`) |
| 65 | + - Data pipeline (data-manager / MOTIS / Transitous) |
| 66 | + - Documentation |
| 67 | + - Other / not sure |
30 | 68 | validations: |
31 | 69 | required: true |
| 70 | + - type: input |
| 71 | + id: component-id |
| 72 | + attributes: |
| 73 | + label: Specific integration / service id |
| 74 | + description: If the area above is an integration or service, name it. |
| 75 | + placeholder: "integrations/transit-hafas, services/valhalla, …" |
32 | 76 | - type: input |
33 | 77 | id: version |
34 | 78 | attributes: |
35 | 79 | label: Version / commit |
36 | 80 | description: Tag, release, or short SHA from `git rev-parse --short HEAD`. |
37 | 81 | validations: |
38 | 82 | required: true |
| 83 | + - type: input |
| 84 | + id: last-working |
| 85 | + attributes: |
| 86 | + label: Last working version |
| 87 | + description: If this used to work, the last version/commit where it did (helps us bisect). Leave blank if unknown. |
39 | 88 | - type: textarea |
40 | 89 | id: environment |
41 | 90 | attributes: |
42 | 91 | label: Environment |
43 | | - description: OS, Node version, pnpm version, browser (if web), Docker version (if self-hosted), which services / integrations enabled. |
| 92 | + description: Required for self-hosted and local-dev reports. You can skip it for the hosted app. |
44 | 93 | placeholder: | |
45 | 94 | OS: macOS 15.0 / Ubuntu 24.04 |
46 | 95 | Node: 24.x |
47 | 96 | pnpm: 11.x |
48 | | - Browser: Chrome 132 |
49 | | - Services enabled: postgis, martin, valhalla, ... |
50 | | - validations: |
51 | | - required: true |
| 97 | + Browser: Chrome 132 (if a web issue) |
| 98 | + Docker: 27.x (if self-hosted) |
| 99 | + Services enabled: postgis, martin, valhalla, motis, … |
| 100 | + Integrations enabled: geocoding-photon, routing-valhalla, … |
| 101 | + render: text |
52 | 102 | - type: textarea |
53 | 103 | id: logs |
54 | 104 | attributes: |
55 | | - label: Logs / screenshots |
56 | | - description: Paste any relevant log output (redact secrets) or attach screenshots. |
| 105 | + label: Relevant logs and/or screenshots |
| 106 | + description: | |
| 107 | + Paste relevant log output (`openmapx logs <service>`, browser console, API errors) or attach screenshots. |
| 108 | + **Redact secrets, tokens, and `.env` values.** |
57 | 109 | render: shell |
0 commit comments