From 76241d747c67498a1e24711ac2db741238ce6d45 Mon Sep 17 00:00:00 2001 From: hkimw <54717101+hkimw@users.noreply.github.com> Date: Thu, 7 May 2026 10:48:01 +0900 Subject: [PATCH] docs(templates): refine issue/pr templates for evidence patterns --- ISSUE_TEMPLATE/bug.yml | 66 +++++++++++++++++++++++++++ ISSUE_TEMPLATE/bug_report.yml | 54 ---------------------- ISSUE_TEMPLATE/evidence.yml | 72 ++++++++++++++++++++++++++++++ ISSUE_TEMPLATE/feature.yml | 54 ++++++++++++++++++++++ ISSUE_TEMPLATE/feature_request.yml | 33 -------------- PULL_REQUEST_TEMPLATE.md | 35 ++++----------- 6 files changed, 201 insertions(+), 113 deletions(-) create mode 100644 ISSUE_TEMPLATE/bug.yml delete mode 100644 ISSUE_TEMPLATE/bug_report.yml create mode 100644 ISSUE_TEMPLATE/evidence.yml create mode 100644 ISSUE_TEMPLATE/feature.yml delete mode 100644 ISSUE_TEMPLATE/feature_request.yml diff --git a/ISSUE_TEMPLATE/bug.yml b/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..3808d38 --- /dev/null +++ b/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,66 @@ +name: Bug +description: Report a reproducible defect. +title: "[bug] " +labels: ["type:bug", "status:triage"] +body: + - type: input + id: repository + attributes: + label: Repository + description: Repository and path, if known. + placeholder: "pccxai/repo-name, path/to/file" + validations: + required: true + - type: input + id: version + attributes: + label: Version or commit + description: Tag, branch, or commit where the defect was observed. + placeholder: "main at abc1234" + validations: + required: true + - type: textarea + id: observed + attributes: + label: Observed result + description: What happened? + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected result + description: What should have happened? + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Reproduction + description: Minimal commands, inputs, or steps. + placeholder: | + 1. ... + 2. ... + 3. ... + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: OS, toolchain versions, target board, and other relevant context. + - type: checkboxes + id: evidence_available + attributes: + label: Evidence available + description: Optional. Mark evidence that can be attached now or linked from the issue. + options: + - label: Failing command, log excerpt, or CI run + - label: Timing, synthesis, implementation, or utilization report + - label: Board run, serial log, screenshot, or host output + - label: Minimal reproducer, trace, or input fixture + - type: textarea + id: evidence + attributes: + label: Evidence links or excerpts + description: Optional. Link reports, checks, logs, screenshots, traces, or board records. Say "not available yet" if evidence is pending. diff --git a/ISSUE_TEMPLATE/bug_report.yml b/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 8857694..0000000 --- a/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,54 +0,0 @@ -name: Bug report -description: Report a defect that affects published behaviour, builds, or documentation. -title: "[bug] " -labels: ["bug"] -body: - - type: markdown - attributes: - value: | - Please file a bug report only for issues that affect published behaviour, builds, or documentation. For questions or design discussions, use Discussions instead. - - type: input - id: version - attributes: - label: Affected version or commit - description: Tag, release, or commit SHA where the bug was observed. - placeholder: "v0.1.0 or commit abc1234" - validations: - required: true - - type: textarea - id: actual - attributes: - label: Observed behaviour - description: What happens? - validations: - required: true - - type: textarea - id: expected - attributes: - label: Expected behaviour - description: What did you expect instead? - validations: - required: true - - type: textarea - id: repro - attributes: - label: Steps to reproduce - description: Minimal commands or actions to reproduce. - placeholder: | - 1. ... - 2. ... - 3. ... - validations: - required: true - - type: textarea - id: environment - attributes: - label: Environment - description: OS, toolchain versions, target hardware where relevant. - placeholder: "Ubuntu 24.04, rustc 1.75, KV260, ..." - - type: textarea - id: logs - attributes: - label: Relevant logs or output - description: Paste log excerpts inside a fenced code block. - render: shell diff --git a/ISSUE_TEMPLATE/evidence.yml b/ISSUE_TEMPLATE/evidence.yml new file mode 100644 index 0000000..9323e19 --- /dev/null +++ b/ISSUE_TEMPLATE/evidence.yml @@ -0,0 +1,72 @@ +name: Evidence +description: Submit or request evidence for repository claims, release gates, or review decisions. +title: "[evidence] " +labels: ["type:docs", "area:verification", "status:triage"] +body: + - type: input + id: repository + attributes: + label: Repository + description: Repository where the claim, gate, or review decision lives. + placeholder: "pccxai/repo-name" + validations: + required: true + - type: textarea + id: subject + attributes: + label: Subject + description: Claim, release gate, or review decision that needs evidence. + validations: + required: true + - type: textarea + id: timing_state + attributes: + label: Timing state + description: Timing status, target clock, WNS/TNS, failing paths, report link, or "not run". + placeholder: | + Target clock: + WNS/TNS: + Report path or link: + Status: + validations: + required: true + - type: textarea + id: synthesis_state + attributes: + label: Synthesis and implementation state + description: Tool/version, commit, utilization, DSP/BRAM/LUT/FF counts, implementation status, report link, or "not run". + placeholder: | + Tool/version: + Commit: + Utilization: + Report path or link: + Status: + validations: + required: true + - type: textarea + id: board_state + attributes: + label: Board state + description: Target board, bitstream, host command, driver/app version, serial log, screenshot, output link, or "not run". + placeholder: | + Board: + Bitstream: + Host command: + Output path or link: + Status: + validations: + required: true + - type: textarea + id: evidence_links + attributes: + label: Evidence links + description: Logs, reports, checks, screenshots, commits, or board records. Say "missing" for each unavailable item. + validations: + required: true + - type: textarea + id: limits + attributes: + label: Limits + description: Known gaps, blocked inputs, unsupported scope, stale reports, or follow-up work. + validations: + required: true diff --git a/ISSUE_TEMPLATE/feature.yml b/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..e89cef9 --- /dev/null +++ b/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,54 @@ +name: Feature +description: Propose a scoped capability or repository change. +title: "[feature] " +labels: ["type:feature", "status:triage"] +body: + - type: input + id: repository + attributes: + label: Repository + description: Target repository or repositories. + placeholder: "pccxai/repo-name" + validations: + required: true + - type: textarea + id: problem + attributes: + label: Problem + description: What concrete problem does this solve? + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposal + description: Describe the smallest useful change. + validations: + required: true + - type: textarea + id: boundary + attributes: + label: Boundary + description: What is in scope, and what is explicitly out of scope? + validations: + required: true + - type: checkboxes + id: decision_required + attributes: + label: Decision required + description: Optional. Use a checked item when maintainer confirmation is needed before implementation. Copy the relevant [CONFIRM] line into the issue body or follow-up PR. + options: + - label: "[CONFIRM] Choose the architecture, data format, or policy before implementation." + - label: "[CONFIRM] Choose the parameter, limit, default value, or accounting baseline before implementation." + - label: "[CONFIRM] Choose the timing, synthesis, board, or release gate before implementation." + - label: No maintainer decision required; the proposal can proceed as scoped. + - type: textarea + id: evidence + attributes: + label: Evidence or references + description: Related issues, design notes, traces, logs, board records, or prior work. + - type: textarea + id: acceptance + attributes: + label: Acceptance checks + description: How should maintainers verify this is done? diff --git a/ISSUE_TEMPLATE/feature_request.yml b/ISSUE_TEMPLATE/feature_request.yml deleted file mode 100644 index aad1462..0000000 --- a/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,33 +0,0 @@ -name: Feature request -description: Propose new capability or scope expansion. -title: "[feature] " -labels: ["enhancement"] -body: - - type: markdown - attributes: - value: | - For open-ended ideas, consider a Discussion first. Use this form when the proposal is concrete enough to scope into a single change. - - type: textarea - id: motivation - attributes: - label: Motivation - description: What problem does this solve, and for whom? - validations: - required: true - - type: textarea - id: proposal - attributes: - label: Proposed solution - description: How would it work? Diagrams, pseudocode, or interface sketches welcome. - validations: - required: true - - type: textarea - id: alternatives - attributes: - label: Alternatives considered - description: Optional. Other approaches you weighed and why this one is preferred. - - type: textarea - id: scope - attributes: - label: Out of scope - description: Optional. What this proposal explicitly does not cover. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 846f057..296b268 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,34 +1,17 @@ - - ## Summary - - -## Type of change - -- [ ] Bug fix -- [ ] New feature -- [ ] Documentation -- [ ] Refactor / cleanup -- [ ] Build / CI / chore +- -## Verification +## Evidence State - +Evidence state: -## Linked issues +stacking on: - +## Review -## Engineering checklist - -- [ ] Scope is small and bounded -- [ ] Public interface or boundary is clear -- [ ] Tests/smoke checks were run +- [ ] Scope is bounded +- [ ] Labels and linked issues are correct +- [ ] Public wording is backed by evidence - [ ] No overclaim about production readiness, timing closure, KV260 inference, or stable ABI -- [ ] No unrelated repo settings, release, tag, or visibility changes -- [ ] Critical architecture assumptions are stated - -## Notes for reviewer - - +- [ ] No unrelated settings, release, tag, or visibility changes