Skip to content

Commit 2e6dbfb

Browse files
authored
Convert YAML issue templates to Markdown with H2 headings (#104)
1 parent fddade6 commit 2e6dbfb

File tree

10 files changed

+411
-731
lines changed

10 files changed

+411
-731
lines changed
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug in the PROVES Core Reference F Prime Zephyr implementation
4+
title: "[BUG]: "
5+
labels: bug
6+
---
7+
8+
Thanks for taking the time to report a bug! Please fill out the information below to help us diagnose and fix the issue.
9+
10+
## Target Board/Platform
11+
<!-- Which board or platform are you using? -->
12+
<!-- Options: -->
13+
<!-- - proves_flight_control_board_v5c/rp2350a/m33 -->
14+
<!-- - proves_flight_control_board_v5d/rp2350a/m33 -->
15+
<!-- - proves_flight_control_board_v5/rp2350a/m33 -->
16+
<!-- - Raspberry Pi Pico 2 -->
17+
<!-- - STM32 (specify in description) -->
18+
<!-- - Other (specify in description) -->
19+
20+
## Steps to Reproduce
21+
<!-- Provide detailed steps to reproduce the bug -->
22+
<!-- Example:
23+
1. Run 'make build'
24+
2. Flash firmware to board
25+
3. Connect GDS with 'make gds'
26+
4. Send command XYZ
27+
5. Observe error...
28+
-->
29+
30+
## Expected Behavior
31+
<!-- What did you expect to happen? -->
32+
33+
## Actual Behavior
34+
<!-- What actually happened? -->
35+
36+
## Relevant Logs
37+
<!-- Please paste any relevant logs, error messages, or console output -->
38+
```
39+
Paste logs here...
40+
```
41+
42+
## Component Affected
43+
<!-- Which part of the system is affected by this bug? (can select multiple) -->
44+
<!-- Options: -->
45+
<!-- - Deployment (ReferenceDeployment) -->
46+
<!-- - Topology (component connections) -->
47+
<!-- - Active Component (AntennaDeployer, BootloaderTrigger, etc.) -->
48+
<!-- - Passive Component -->
49+
<!-- - Driver Component (Drv/) -->
50+
<!-- - Build System (CMakeLists.txt, Makefile) -->
51+
<!-- - Integration/Testing (GDS, pytest) -->
52+
<!-- - Zephyr Configuration (prj.conf, Kconfig) -->
53+
<!-- - FPP Definition Files -->
54+
<!-- - Hardware/Board Configuration -->
55+
<!-- - Documentation -->
56+
<!-- - Other (specify in description) -->
57+
58+
## F Prime Version
59+
<!-- Which version of F Prime are you using? (check lib/fprime/) -->
60+
<!-- Example: v4.0.0a1 -->
61+
62+
## Zephyr Version
63+
<!-- Which version of Zephyr are you using? (check west.yml) -->
64+
<!-- Example: v4.2.0 -->
65+
66+
## Additional Context
67+
<!-- Add any other context about the problem here (environment, configuration changes, etc.) -->

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 0 additions & 110 deletions
This file was deleted.
Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
name: Build/Integration Issue
3+
about: Report problems with the build system, CMake, Zephyr integration, or toolchain
4+
title: "[BUILD]: "
5+
labels: build, integration
6+
---
7+
8+
Use this template for issues related to building, compiling, linking, or integrating the F Prime Zephyr project.
9+
10+
## Build Stage
11+
<!-- At what stage does the build fail? -->
12+
<!-- Options: -->
13+
<!-- - Submodule initialization (make submodules) -->
14+
<!-- - Python environment setup (make fprime-venv) -->
15+
<!-- - Zephyr setup (make zephyr-setup) -->
16+
<!-- - F Prime generation (make generate) -->
17+
<!-- - Build/Compilation (make build) -->
18+
<!-- - Linking -->
19+
<!-- - Flashing/Upload -->
20+
<!-- - Runtime/Execution -->
21+
<!-- - Testing (make test-integration) -->
22+
<!-- - Other (specify in description) -->
23+
24+
## Build System/Tool Versions
25+
<!-- Provide version information for your build environment -->
26+
<!-- Example:
27+
- OS: Ubuntu 22.04 / macOS 14.0 / Windows 11 + WSL2
28+
- Python version: 3.13.0 (from `python --version`)
29+
- CMake version: 3.28.0 (from `cmake --version`)
30+
- GCC/ARM toolchain: (from `arm-none-eabi-gcc --version` or Zephyr SDK version)
31+
- UV version: 0.8.13 (from `uv --version`)
32+
- F Prime version: v4.0.0a1 (from lib/fprime/ git tag)
33+
- Zephyr version: v4.2.0 (from west.yml)
34+
- Make version: (from `make --version`)
35+
-->
36+
37+
## Build Configuration
38+
<!-- What is your build configuration? -->
39+
<!-- Example:
40+
- Board: proves_flight_control_board_v5d/rp2350a/m33
41+
- Build type: Release
42+
- Custom CMake options: (if any)
43+
- Environment variables: (if any special settings)
44+
- Settings from settings.ini: (if modified)
45+
-->
46+
47+
## Error Messages
48+
<!-- Paste the complete error output from the build -->
49+
```
50+
[build output here]
51+
```
52+
53+
## Relevant CMakeLists.txt Snippet
54+
<!-- If the issue relates to CMake configuration, paste the relevant section -->
55+
```cmake
56+
# From FprimeZephyrReference/Components/MyComponent/CMakeLists.txt
57+
# Paste relevant CMake code here
58+
```
59+
60+
## Relevant prj.conf Snippet
61+
<!-- If the issue relates to Zephyr configuration, paste the relevant section -->
62+
```
63+
# From prj.conf
64+
# Paste relevant Zephyr configuration here
65+
```
66+
67+
## Steps to Reproduce
68+
<!-- Provide exact steps to reproduce the build issue -->
69+
<!-- Example:
70+
1. Fresh clone: `git clone https://github.com/Open-Source-Space-Foundation/proves-core-reference`
71+
2. Run: `make submodules`
72+
3. Run: `make fprime-venv`
73+
4. Run: `make zephyr-setup`
74+
5. Run: `make generate`
75+
6. Run: `make build`
76+
7. Error occurs at step 6...
77+
-->
78+
79+
## Clean Build Test
80+
<!-- Did you try a clean build? -->
81+
<!-- Options: -->
82+
<!-- - Yes, I ran 'make clean' and rebuilt -->
83+
<!-- - No, I haven't tried a clean build yet -->
84+
<!-- - Not applicable -->
85+
86+
## Workaround
87+
<!-- Have you found any workarounds for this issue? -->
88+
89+
## Additional Build Logs
90+
<!-- If available, paste additional logs (CMake configure output, verbose build output) -->
91+
```
92+
# Output from: make build VERBOSE=1
93+
```
94+
95+
## Affects CI/CD
96+
<!-- Does this issue affect continuous integration builds? -->
97+
<!-- Options: -->
98+
<!-- - Yes, CI builds are failing -->
99+
<!-- - No, only affects local builds -->
100+
<!-- - Unknown -->
101+
102+
## Additional Context
103+
<!-- Any other relevant information about the build issue -->

0 commit comments

Comments
 (0)