Skip to content

Commit b0cd6b6

Browse files
tbitcsoz-agent
andcommitted
chore: Zephyr-standard issue/PR templates, template chooser config
- Enhanced bug report: environment details, ARB model section, impact checkboxes - Enhanced feature request: affected components, requirements impact - Enhanced PR template: type of change, full governance checklist - Added config.yml to disable blank issues, add contact links Co-Authored-By: Oz <oz-agent@warp.dev>
1 parent e510a4b commit b0cd6b6

4 files changed

Lines changed: 79 additions & 19 deletions

File tree

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,48 @@
11
---
22
name: Bug Report
3-
about: Report a bug in arbiter
3+
about: Report a bug in Arbiter
44
title: "[BUG] "
55
labels: bug
66
assignees: ''
77
---
88

9-
## Description
10-
A clear description of the bug.
9+
## Describe the Bug
10+
A clear and concise description of the bug.
1111

12-
## Steps to Reproduce
12+
## To Reproduce
13+
Steps to reproduce the behavior:
1314
1.
1415
2.
1516
3.
1617

1718
## Expected Behavior
19+
What you expected to happen.
1820

1921
## Actual Behavior
22+
What actually happened. Include logs, error output, or screenshots.
2023

2124
## Environment
22-
- Zephyr version:
23-
- Board/target:
24-
- arbiter version:
25-
- Python version:
26-
- OS:
25+
- **Zephyr version**: (e.g., v4.4.0)
26+
- **Board/target**: (e.g., native_sim, nrf52840dk)
27+
- **Arbiter version**: (e.g., v0.1.0 or commit hash)
28+
- **Python version**: (e.g., 3.12.0)
29+
- **OS**: (e.g., Windows 11, Ubuntu 24.04)
30+
- **Toolchain**: (e.g., Zephyr SDK 0.16.8, GCC 12.3)
31+
32+
## ARB Model (if applicable)
33+
```yaml
34+
# Paste relevant model snippet
35+
```
36+
37+
## Logs
38+
```
39+
# Paste relevant build or runtime output
40+
```
41+
42+
## Impact
43+
- [ ] Build failure
44+
- [ ] Runtime crash/hang
45+
- [ ] Incorrect evaluation result
46+
- [ ] Safety-relevant (wrong mode/action)
47+
- [ ] Compiler (arbiterc) error
48+
- [ ] Documentation issue

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Zephyr Project
4+
url: https://docs.zephyrproject.org/
5+
about: Zephyr RTOS documentation
6+
- name: Arbiter Documentation
7+
url: https://github.com/BitConcepts/arbiter/tree/main/doc
8+
about: Arbiter user documentation and API reference
Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,31 @@
11
---
22
name: Feature Request
3-
about: Suggest a feature for arbiter
3+
about: Suggest a feature for Arbiter
44
title: "[FEATURE] "
55
labels: enhancement
66
assignees: ''
77
---
88

99
## Problem Statement
10-
What problem does this feature solve?
10+
What problem does this feature solve? What use case is not currently supported?
1111

1212
## Proposed Solution
13-
Describe the desired behavior.
13+
Describe the desired behavior and how it would work.
1414

1515
## Alternatives Considered
16-
What other approaches were considered?
16+
What other approaches were considered and why were they rejected?
17+
18+
## Affected Components
19+
- [ ] C runtime engine (`lib/`)
20+
- [ ] Python compiler (`python/arbiter/`)
21+
- [ ] ARB model format / schema
22+
- [ ] Zephyr subsystem (`subsys/arbiter/`)
23+
- [ ] Samples
24+
- [ ] Documentation
25+
- [ ] Safety artifacts
26+
27+
## Requirements Impact
28+
Does this require new REQ-* entries in `docs/REQUIREMENTS.md`?
1729

1830
## Additional Context
31+
Any other context, diagrams, or references.

.github/pull_request_template.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,27 @@
11
## Description
2-
Brief description of changes.
2+
Brief description of changes and motivation.
3+
4+
Fixes # (issue number)
5+
6+
## Type of Change
7+
- [ ] Bug fix (non-breaking)
8+
- [ ] New feature (non-breaking)
9+
- [ ] Breaking change
10+
- [ ] Documentation update
11+
- [ ] Safety-relevant change
12+
13+
## Testing
14+
Describe tests run and results.
315

416
## Checklist
5-
- [ ] SPDX license headers on all new files
6-
- [ ] Tests added or updated
7-
- [ ] Documentation updated
8-
- [ ] Python tests pass (`pytest tests/python`)
17+
- [ ] SPDX license headers on all new files (`SPDX-License-Identifier: MIT`)
18+
- [ ] C code follows Zephyr coding style (tabs, K&R braces)
19+
- [ ] Python code passes `ruff check python/` and `mypy python/arbiter/`
20+
- [ ] Tests added or updated and passing (`pytest tests/python -v`)
21+
- [ ] Documentation updated (README, doc/, safety/ if applicable)
22+
- [ ] Requirements updated (`docs/REQUIREMENTS.md`) if new functionality
23+
- [ ] Test coverage updated (`docs/TESTS.md`) for new requirements
24+
- [ ] ARB models validate (`arbiterc validate --strict`)
925
- [ ] No new warnings
10-
- [ ] Follows Zephyr coding style (C) / PEP 8 (Python)
26+
- [ ] Commit messages follow conventional commits format
27+
- [ ] Safety artifacts updated if safety-relevant (`safety/`)

0 commit comments

Comments
 (0)