From 8af418ed1ab17ee13295e4e3f0e488b6e4492033 Mon Sep 17 00:00:00 2001 From: sepehr-safari Date: Tue, 7 Jul 2026 23:09:49 +0300 Subject: [PATCH] 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 --- .github/ISSUE_TEMPLATE/bug_report.md | 41 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 26 ++++++++++++++ .github/ISSUE_TEMPLATE/scenario_request.md | 33 +++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 32 +++++++++++++++++ CURRENT_STATE.md | 13 ++++--- 5 files changed, 141 insertions(+), 4 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/scenario_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..647c2d0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,41 @@ +--- +name: Bug Report +about: Report something that isn't working as expected +title: 'bug: ' +labels: type:bug +--- + +## Describe the Bug + + + +## Steps to Reproduce + +1. +2. +3. + +## Expected Behavior + + + +## Actual Behavior + + + +## Environment + +- OCPP DebugKit version: +- Node.js version: +- OS: +- Browser (if applicable): + +## Trace / Input + + + +``` +(paste here) +``` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..939eeea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,26 @@ +--- +name: Feature Request +about: Suggest a new feature or enhancement +title: 'feat: ' +labels: type:feature +--- + +## Feature Description + + + +## Problem / Motivation + + + +## Proposed Solution + + + +## Alternatives Considered + + + +## Additional Context + + diff --git a/.github/ISSUE_TEMPLATE/scenario_request.md b/.github/ISSUE_TEMPLATE/scenario_request.md new file mode 100644 index 0000000..d93a160 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/scenario_request.md @@ -0,0 +1,33 @@ +--- +name: Scenario Request +about: Propose a new OCPP trace scenario for the scenario evaluator +title: 'scenario: ' +labels: type:feature,package:scenarios +--- + +## Scenario Name + + + +## Description + + + +## Expected Failures + + + +## Trace Events + + + +## OCPP Version + + + +## Additional Context + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..99b09b9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,32 @@ +## Summary + + + +## Related Issue + + + +Closes # + +## Changes + + + +- + +## Checklist + +- [ ] Tests added or updated for the behavior this PR introduces +- [ ] Lint passes (`pnpm lint`) +- [ ] Typecheck passes (`pnpm typecheck`) +- [ ] Tests pass (`pnpm test`) +- [ ] Build passes (`pnpm build`) +- [ ] Changeset added (if changing publishable package behavior) +- [ ] `CURRENT_STATE.md` updated (if applicable) +- [ ] `AGENTS.md` updated (if architecture or build commands changed) +- [ ] No secrets or sensitive data in committed artifacts +- [ ] Untrusted-input handling reviewed (if touching parsing, CLI, or UI) + +## Notes for Reviewer + + diff --git a/CURRENT_STATE.md b/CURRENT_STATE.md index afa83ab..064d009 100644 --- a/CURRENT_STATE.md +++ b/CURRENT_STATE.md @@ -37,11 +37,16 @@ feature code lands. - ✅ `.github/workflows/release.yml` — Changesets version PR, npm publish, ecosystem tag + GitHub release - ✅ `.changeset/config.json` — public access, base branch main -## What's Next +### GitHub Templates (in progress — this PR) +- ✅ `.github/PULL_REQUEST_TEMPLATE.md` +- ✅ `.github/ISSUE_TEMPLATE/bug_report.md` +- ✅ `.github/ISSUE_TEMPLATE/feature_request.md` +- ✅ `.github/ISSUE_TEMPLATE/scenario_request.md` -1. **PR3** (Issues #7–#8): PR template + issue templates -2. **PR4** (Issues #9–#11): CONTRIBUTING, CODE_OF_CONDUCT, ROADMAP, README -3. **M0 complete** → proceed to M0.5 (Protocol & Trace-Format Design Phase) + + +1. **PR4** (Issues #9–#11): CONTRIBUTING, CODE_OF_CONDUCT, ROADMAP, README +2. **M0 complete** → proceed to M0.5 (Protocol & Trace-Format Design Phase) ## Known Blockers / Decisions Pending