Skip to content

Commit 8af418e

Browse files
sepehr-safarisepehr-safari
committed
chore: add PR template + issue templates
- .github/PULL_REQUEST_TEMPLATE.md: summary, related issue, changes, checklist (tests, lint, typecheck, changeset, docs, security review) - .github/ISSUE_TEMPLATE/bug_report.md: repro steps, expected/actual, environment, trace input (with sensitive-data warning) - .github/ISSUE_TEMPLATE/feature_request.md: description, motivation, proposed solution, alternatives - .github/ISSUE_TEMPLATE/scenario_request.md: scenario name, expected failures, trace events, OCPP version Closes #7, closes #8
1 parent 4482e75 commit 8af418e

5 files changed

Lines changed: 141 additions & 4 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug Report
3+
about: Report something that isn't working as expected
4+
title: 'bug: '
5+
labels: type:bug
6+
---
7+
8+
## Describe the Bug
9+
10+
<!-- A clear description of what the bug is. -->
11+
12+
## Steps to Reproduce
13+
14+
1.
15+
2.
16+
3.
17+
18+
## Expected Behavior
19+
20+
<!-- What you expected to happen. -->
21+
22+
## Actual Behavior
23+
24+
<!-- What actually happened. -->
25+
26+
## Environment
27+
28+
- OCPP DebugKit version:
29+
- Node.js version:
30+
- OS:
31+
- Browser (if applicable):
32+
33+
## Trace / Input
34+
35+
<!-- If applicable, paste a minimal trace or input that triggers the bug.
36+
Do NOT include real station IDs, transaction IDs, or sensitive data —
37+
use anonymized/synthetic data. -->
38+
39+
```
40+
(paste here)
41+
```

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: 'feat: '
5+
labels: type:feature
6+
---
7+
8+
## Feature Description
9+
10+
<!-- A clear description of the feature you'd like to see. -->
11+
12+
## Problem / Motivation
13+
14+
<!-- What problem does this feature solve? Why is it needed? -->
15+
16+
## Proposed Solution
17+
18+
<!-- How do you envision this working? -->
19+
20+
## Alternatives Considered
21+
22+
<!-- Any alternative solutions or features you've considered. -->
23+
24+
## Additional Context
25+
26+
<!-- Anything else relevant (screenshots, links, examples, etc.) -->

‎.github/ISSUE_TEMPLATE/scenario_request.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Scenario Request
3+
about: Propose a new OCPP trace scenario for the scenario evaluator
4+
title: 'scenario: '
5+
labels: type:feature,package:scenarios
6+
---
7+
8+
## Scenario Name
9+
10+
<!-- A short, descriptive name for the scenario (e.g., "Failed Authorization") -->
11+
12+
## Description
13+
14+
<!-- What OCPP session pattern does this scenario represent? What should it detect? -->
15+
16+
## Expected Failures
17+
18+
<!-- Which failure rules should this scenario trigger? (e.g., FAILED_AUTHORIZATION, CONNECTOR_FAULT) -->
19+
20+
## Trace Events
21+
22+
<!-- Describe the key events in the scenario:
23+
- Message types and directions (CS→CSMS or CSMS→CS)
24+
- Expected sequence
25+
- What goes wrong -->
26+
27+
## OCPP Version
28+
29+
<!-- Which OCPP version? (1.6 JSON, 2.0.1, etc.) -->
30+
31+
## Additional Context
32+
33+
<!-- Any relevant details about the session, station, or connector behavior -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Summary
2+
3+
<!-- Brief description of what this PR does and why -->
4+
5+
## Related Issue
6+
7+
<!-- Link to the issue this PR addresses. Use "Closes #N" to auto-close on merge. -->
8+
9+
Closes #
10+
11+
## Changes
12+
13+
<!-- List the key changes in this PR -->
14+
15+
-
16+
17+
## Checklist
18+
19+
- [ ] Tests added or updated for the behavior this PR introduces
20+
- [ ] Lint passes (`pnpm lint`)
21+
- [ ] Typecheck passes (`pnpm typecheck`)
22+
- [ ] Tests pass (`pnpm test`)
23+
- [ ] Build passes (`pnpm build`)
24+
- [ ] Changeset added (if changing publishable package behavior)
25+
- [ ] `CURRENT_STATE.md` updated (if applicable)
26+
- [ ] `AGENTS.md` updated (if architecture or build commands changed)
27+
- [ ] No secrets or sensitive data in committed artifacts
28+
- [ ] Untrusted-input handling reviewed (if touching parsing, CLI, or UI)
29+
30+
## Notes for Reviewer
31+
32+
<!-- Anything the reviewer should pay attention to -->

‎CURRENT_STATE.md‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,16 @@ feature code lands.
3737
- ✅ `.github/workflows/release.yml` — Changesets version PR, npm publish, ecosystem tag + GitHub release
3838
- ✅ `.changeset/config.json` — public access, base branch main
3939

40-
## What's Next
40+
### GitHub Templates (in progress — this PR)
41+
- ✅ `.github/PULL_REQUEST_TEMPLATE.md`
42+
- ✅ `.github/ISSUE_TEMPLATE/bug_report.md`
43+
- ✅ `.github/ISSUE_TEMPLATE/feature_request.md`
44+
- ✅ `.github/ISSUE_TEMPLATE/scenario_request.md`
4145

42-
1. **PR3** (Issues #7–#8): PR template + issue templates
43-
2. **PR4** (Issues #9–#11): CONTRIBUTING, CODE_OF_CONDUCT, ROADMAP, README
44-
3. **M0 complete** → proceed to M0.5 (Protocol & Trace-Format Design Phase)
46+
47+
48+
1. **PR4** (Issues #9–#11): CONTRIBUTING, CODE_OF_CONDUCT, ROADMAP, README
49+
2. **M0 complete** → proceed to M0.5 (Protocol & Trace-Format Design Phase)
4550

4651
## Known Blockers / Decisions Pending
4752

0 commit comments

Comments
 (0)