diff --git a/.github/ISSUE_TEMPLATE/architecture_proposal.md b/.github/ISSUE_TEMPLATE/architecture_proposal.md deleted file mode 100644 index 8020076..0000000 --- a/.github/ISSUE_TEMPLATE/architecture_proposal.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Architecture proposal -about: Propose or revise an architectural decision. -title: "architecture: " -labels: "type:governance, component:foundation, status:needs-design" ---- - -## Context - -What decision is needed and why now? - -## Evidence - -List repository evidence, tests, constraints, and related issues. - -## Proposal - -Describe the proposed architecture or boundary. - -## Alternatives - -List credible alternatives and tradeoffs. - -## ADR impact - -- [ ] New ADR needed. -- [ ] Existing ADR updated. -- [ ] No ADR needed. - -## Issue governance - -Apply the [Issue Governance Standard](../../docs/reference/ISSUE_GOVERNANCE.md) -during triage: - -- Priority label: -- Component label(s): -- Status label: -- Milestone: -- Related issues or pull requests: diff --git a/.github/ISSUE_TEMPLATE/architecture_proposal.yml b/.github/ISSUE_TEMPLATE/architecture_proposal.yml new file mode 100644 index 0000000..9b4588a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/architecture_proposal.yml @@ -0,0 +1,56 @@ +name: Architecture proposal +description: Propose or revise an architectural decision +title: "[Architecture]: " +labels: + - "type:governance" + - "component:foundation" + - "status:needs-design" +body: + - type: input + id: summary + attributes: + label: Decision summary + description: In one short sentence, what needs to be decided? + validations: + required: true + + - type: textarea + id: context + attributes: + label: Context + description: What decision is needed, and why now? + validations: + required: true + + - type: textarea + id: evidence + attributes: + label: Evidence + description: List repository evidence, tests, constraints, and related issues. + validations: + required: true + + - type: textarea + id: proposal + attributes: + label: Proposal + description: Describe the proposed architecture or boundary. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: List credible alternatives and their tradeoffs. + + - type: dropdown + id: adr-impact + attributes: + label: Decision record (ADR) impact + options: + - New ADR needed + - Existing ADR updated + - No ADR needed + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index e12a457..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: Bug report -about: Report behavior that is incorrect, unsafe, or surprising. -title: "bug: " -labels: "type:bug, status:needs-investigation" ---- - -## What happened? - -Describe the observed behavior. - -## Expected behavior - -Describe what should have happened. - -## Evidence - -Include files, commands, logs, screenshots, or steps to reproduce. - -## Reproduction steps - -1. -2. -3. - -## Impact - -Explain whether this affects correctness, security, user experience, or production safety. - -## Tests - -List tests that currently fail or should be added. - -## Issue governance - -Apply the [Issue Governance Standard](../../docs/reference/ISSUE_GOVERNANCE.md) -during triage: - -- Priority label: -- Component label(s): -- Status label: -- Milestone: -- Related issues or pull requests: diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..d7f3042 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,184 @@ +name: Bug report +description: Tell us what went wrong so we can reproduce and fix it +title: "[Bug]: " +labels: + - "type:bug" + - "status:needs-investigation" +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a problem. + + Please search existing issues first. Include exact text where you can, + and remove private or sensitive information before attaching anything. + Provider guide and playlist files often contain account names, tokens, + and private URLs. Never paste those. + + - type: input + id: summary + attributes: + label: Problem summary + description: In one short sentence, what is going wrong? + placeholder: Example - A pay-per-view channel kept its provider guide instead of getting an event guide + validations: + required: true + + - type: input + id: channelforge-version + attributes: + label: ChannelForge version or release + description: Enter the exact version or release identifier shown by your copy. Check the Releases page if you need help identifying it. + placeholder: Example - v0.1.0 or a development build + validations: + required: true + + - type: textarea + id: windows-powershell + attributes: + label: Windows and PowerShell environment + description: Include Windows edition and build, 32-bit or 64-bit, PowerShell version, and how you started ChannelForge (for example Windows PowerShell, PowerShell 7, Windows Terminal, the desktop app, or a scheduled task). + placeholder: | + Windows edition/build: + Architecture: + PowerShell version: + How ChannelForge was started: + validations: + required: true + + - type: dropdown + id: affected-area + attributes: + label: Affected area + description: Choose the closest match. Maintainers use this to apply the repository's component label. + options: + - Desktop app screens, setup, or review (component:ux) + - Channel matching, names, or corrections (component:identity) + - Guide data, artwork, or stream details (component:guide-media) + - Event or sports channels and event guides (component:events) + - Output files, playlists, or deployment (component:delivery) + - Stored data, schemas, or saved state (component:data) + - Automation, scheduled runs, or notifications (component:operations) + - Rules, policy packs, or adapters (component:policy-sdk) + - Security or secrets (component:security) + - Tests or test tooling (component:testing) + - Documentation (component:documentation) + - Release packaging or versioning (component:release) + - GitHub, CI, or repository tooling (component:github) + - Other or not sure + validations: + required: true + + - type: input + id: affected-item + attributes: + label: Affected channel, provider, or feature + description: Name the channel, provider guide, playlist, screen, or command involved. If none applies, say so. Do not include account names or private URLs. + placeholder: Example - "PPV1" channel from my provider guide, during Build-Lineup + validations: + required: true + + - type: textarea + id: trying-to-do + attributes: + label: What were you trying to do? + description: Describe the task you were performing just before the problem happened. + placeholder: | + I was trying to... + validations: + required: true + + - type: textarea + id: observed-behavior + attributes: + label: What happened? + description: Describe exactly what you saw. Paste the complete error text or console output when available. If there was no error text, say "No error text". + placeholder: | + Exact error text or observed behavior: + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: What did you expect to happen? + description: Describe the result you expected from that action. For guide problems, include the correct title, start time, venue, or channel if you know them. + placeholder: | + I expected... + validations: + required: true + + - type: textarea + id: reproduction-steps + attributes: + label: Steps to reproduce + description: Give numbered steps from a clean start or known state. Include the exact screens, commands, options, and file names needed to reproduce it. + placeholder: | + 1. Start with... + 2. Choose... + 3. Observe... + validations: + required: true + + - type: dropdown + id: reproducibility + attributes: + label: Does it reproduce consistently? + description: Choose the result of repeating the same steps. + options: + - Every time + - Most times + - Intermittent or timing-dependent + - Happened once and cannot be reproduced + - Not tested yet + validations: + required: true + + - type: textarea + id: input-files + attributes: + label: Provider guide, playlist, or other input (only if relevant) + description: Tell us what kind of input was involved (provider guide or playlist) and its approximate size. If you can, attach a small redacted excerpt that still shows the problem, such as the few channel and programme lines involved. Do not attach complete files. + placeholder: | + Input type and size, or "Not relevant": + + - type: textarea + id: recent-changes + attributes: + label: Recent changes + description: List anything that changed before the problem appeared, such as a ChannelForge update, a new provider guide, an edited setting, a moved folder, or a Windows update. If nothing changed, say "None known". + placeholder: | + Recent changes: + + - type: textarea + id: logs-and-screenshots + attributes: + label: Logs, reports, or screenshots + description: Optional. Before pasting or attaching anything, remove passwords, tokens, API keys, account names, personal data, private URLs or paths, IP addresses, usernames, and machine names that are not needed. Review screenshots for the same information. If none are available, say "None". + placeholder: | + Paste a redacted excerpt or drag in a redacted file or screenshot: + + - type: textarea + id: workaround + attributes: + label: Workaround (if known) + description: Tell us whether anything lets you complete the task, even if it is temporary. + placeholder: | + Workaround, or "None known": + + - type: checkboxes + id: pre-submit-checklist + attributes: + label: Pre-submit checklist + description: Please confirm each item before submitting. + options: + - label: I searched existing issues for duplicates. + required: true + - label: I included the exact ChannelForge version and environment details, or said when they are unavailable. + required: true + - label: I included exact observed text and reproduction steps, or explained what is missing. + required: true + - label: I removed secrets and private information from logs, guides, playlists, and screenshots. + required: true + - label: I described the expected behavior and whether the problem reproduces consistently. + required: true diff --git a/.github/ISSUE_TEMPLATE/documentation_task.md b/.github/ISSUE_TEMPLATE/documentation_task.md deleted file mode 100644 index 8f0e4a2..0000000 --- a/.github/ISSUE_TEMPLATE/documentation_task.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: Documentation task -about: Improve repository or user-facing documentation. -title: "docs: " -labels: "type:documentation, component:docs, status:needs-design" ---- - -## Documentation area - -Choose repository docs, `docs/user/`, or both. Repository docs are the engineering source of truth; `docs/user/` is the user-facing knowledge base. - -Name the page, workflow, or audience. - -## Documentation status - -Use the repository documentation status values from [Documentation Governance -Standard](../../docs/reference/DOCS_AND_WIKI.md): `Not started`, `In Progress`, -`Complete`, or `Needs update`. The current user-facing publication surface is -versioned repository documentation in `docs/user/`. - -## Problem - -What is missing, unclear, outdated, or misleading? - -## Proposed update - -Describe the change. - -## Done when - -- [ ] Repository docs reviewed or updated. -- [ ] `docs/user/` reviewed, updated, or tracked as follow-up. -- [ ] Documentation status is current. - -## Issue governance - -Apply the [Issue Governance Standard](../../docs/reference/ISSUE_GOVERNANCE.md) -during triage: - -- Priority label: -- Component label(s): -- Status label: -- Milestone: -- Related issues or pull requests: diff --git a/.github/ISSUE_TEMPLATE/documentation_task.yml b/.github/ISSUE_TEMPLATE/documentation_task.yml new file mode 100644 index 0000000..36387c1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_task.yml @@ -0,0 +1,63 @@ +name: Documentation task +description: Improve repository or user-facing documentation +title: "[Docs]: " +labels: + - "type:documentation" + - "component:documentation" + - "status:needs-design" +body: + - type: markdown + attributes: + value: | + Repository docs are the engineering source of truth. The `docs/user/` + folder is the user-facing guide. + + - type: input + id: summary + attributes: + label: Summary + description: In one short sentence, what needs to change? + placeholder: Example - Explain how event channels get their own guide + validations: + required: true + + - type: dropdown + id: doc-area + attributes: + label: Documentation area + options: + - Repository docs (engineering) + - User guide (docs/user) + - Both + validations: + required: true + + - type: input + id: page + attributes: + label: Page, workflow, or audience + description: Name the page, workflow, or the people who read it. + validations: + required: true + + - type: textarea + id: problem + attributes: + label: What is missing, unclear, outdated, or misleading? + validations: + required: true + + - type: textarea + id: proposed-update + attributes: + label: Proposed update + description: Describe the change you would like. + + - type: checkboxes + id: done-when + attributes: + label: Done when + options: + - label: Repository docs are reviewed or updated. + - label: The user guide (docs/user) is reviewed, updated, or tracked as follow-up. + - label: The documentation status is current. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index c2a1a5f..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Feature request -about: Propose a new capability or workflow. -title: "feature: " -labels: "type:feature, status:needs-design" ---- - -## Problem - -What user or engineering problem should this solve? - -## Proposed behavior - -Describe the desired workflow or outcome. - -## Evidence - -What repository evidence, user need, or prior decision supports this? - -## Acceptance criteria - -- [ ] -- [ ] -- [ ] - -## Issue governance - -Apply the [Issue Governance Standard](../../docs/reference/ISSUE_GOVERNANCE.md) -during triage: - -- Priority label: -- Component label(s): -- Status label: -- Milestone: -- Related issues or pull requests: - -## Documentation impact - -What docs or user guidance must change? diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..906f61c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,77 @@ +name: Feature request +description: Propose a new capability or workflow +title: "[Feature]: " +labels: + - "type:feature" + - "status:needs-design" +body: + - type: markdown + attributes: + value: | + Thanks for the idea. Please search existing issues first. + Do not include account names, tokens, or private URLs. + + - type: input + id: summary + attributes: + label: Summary + description: In one short sentence, what would you like ChannelForge to do? + placeholder: Example - Show which channels carry the same event + validations: + required: true + + - type: textarea + id: problem + attributes: + label: What problem does this solve? + description: Describe what you are trying to do and what gets in the way today. + placeholder: | + I am trying to... + validations: + required: true + + - type: textarea + id: proposed-behavior + attributes: + label: What should it do? + description: Describe the workflow or result you want, from the user's point of view. + placeholder: | + I would like... + validations: + required: true + + - type: dropdown + id: affected-area + attributes: + label: Closest area + description: Choose the closest match. Maintainers use this to apply the component label. + options: + - Desktop app screens, setup, or review (component:ux) + - Channel matching, names, or corrections (component:identity) + - Guide data, artwork, or stream details (component:guide-media) + - Event or sports channels and event guides (component:events) + - Output files, playlists, or deployment (component:delivery) + - Stored data, schemas, or saved state (component:data) + - Automation, scheduled runs, or notifications (component:operations) + - Rules, policy packs, or adapters (component:policy-sdk) + - Documentation (component:documentation) + - Other or not sure + validations: + required: true + + - type: textarea + id: acceptance + attributes: + label: How will we know it works? + description: List what you would check to say the feature is done. + placeholder: | + - ... + - ... + + - type: textarea + id: alternatives + attributes: + label: Workaround or alternatives (if known) + description: Tell us what you do today, or other ways this could work. + placeholder: | + Workaround, or "None known": diff --git a/.github/ISSUE_TEMPLATE/security_finding.md b/.github/ISSUE_TEMPLATE/security_finding.md deleted file mode 100644 index 1fb117c..0000000 --- a/.github/ISSUE_TEMPLATE/security_finding.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: Security finding -about: Report a security issue, secret exposure, or hardening need. -title: "security: " -labels: "type:security, component:security, status:needs-investigation" ---- - -## Finding - -Describe the security concern. Do not include real secrets or full private URLs. - -## Evidence - -Provide redacted evidence and affected paths. - -## Impact - -Describe what could go wrong if this is not fixed. - -## Remediation - -Describe the safest proposed fix. - -## Verification - -- [ ] Secret scan passes. -- [ ] Tests pass. -- [ ] Documentation updated. -- [ ] Credential rotation considered if exposure occurred. - -## Issue governance - -Apply the [Issue Governance Standard](../../docs/reference/ISSUE_GOVERNANCE.md) -during triage: - -- Priority label: -- Component label(s): -- Status label: -- Milestone: -- Related issues or pull requests: diff --git a/.github/ISSUE_TEMPLATE/security_finding.yml b/.github/ISSUE_TEMPLATE/security_finding.yml new file mode 100644 index 0000000..0a18f9b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/security_finding.yml @@ -0,0 +1,76 @@ +name: Security finding +description: Report a security issue, secret exposure, or hardening need +title: "[Security]: " +labels: + - "type:security" + - "component:security" + - "status:needs-investigation" +body: + - type: markdown + attributes: + value: | + Thanks for reporting a security concern. + + Do not paste real secrets, tokens, passwords, or full private URLs. + Redact anything sensitive before you submit. If the problem is an + active exposure that someone could exploit right now, use the + repository's private security reporting instead of a public issue. + + - type: input + id: summary + attributes: + label: Finding summary + description: In one short sentence, what is the concern? + placeholder: Example - A log file can contain a provider account token + validations: + required: true + + - type: input + id: channelforge-version + attributes: + label: ChannelForge version or release + description: Enter the exact version or release identifier, or say if it is a development build. + validations: + required: true + + - type: textarea + id: finding + attributes: + label: What did you find? + description: Describe the concern and where it appears (file, screen, command, or output). + validations: + required: true + + - type: textarea + id: evidence + attributes: + label: Redacted evidence + description: Provide redacted evidence and the affected paths. Replace any secret with a placeholder such as "REDACTED". + validations: + required: true + + - type: textarea + id: impact + attributes: + label: What could go wrong if this is not fixed? + description: Describe who or what is affected and how likely it is. + validations: + required: true + + - type: textarea + id: remediation + attributes: + label: Suggested fix (if known) + description: Describe the safest fix you can think of. If you have no idea, say so. + + - type: checkboxes + id: pre-submit-checklist + attributes: + label: Pre-submit checklist + options: + - label: I removed real secrets and private information from everything I included. + required: true + - label: This is not an active exposure that needs private reporting. + required: true + - label: If a credential was exposed, I know it may need to be rotated. + required: true diff --git a/.github/ISSUE_TEMPLATE/technical_debt.md b/.github/ISSUE_TEMPLATE/technical_debt.md deleted file mode 100644 index 87e0d32..0000000 --- a/.github/ISSUE_TEMPLATE/technical_debt.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Technical debt -about: Track cleanup, maintainability, or design debt. -title: "tech-debt: " -labels: "type:technical-debt, status:needs-design" ---- - -## Debt - -Describe the maintainability issue. - -## Evidence - -Point to files, repeated patterns, confusing behavior, or review findings. - -## Risk - -What gets harder or more fragile if this stays as-is? - -## Proposed direction - -Describe the smallest useful cleanup. - -## Verification - -List tests, docs, or review steps needed. - -## Issue governance - -Apply the [Issue Governance Standard](../../docs/reference/ISSUE_GOVERNANCE.md) -during triage: - -- Priority label: -- Component label(s): -- Status label: -- Milestone: -- Related issues or pull requests: diff --git a/.github/ISSUE_TEMPLATE/technical_debt.yml b/.github/ISSUE_TEMPLATE/technical_debt.yml new file mode 100644 index 0000000..f7bf5b9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/technical_debt.yml @@ -0,0 +1,50 @@ +name: Technical debt +description: Track cleanup, maintainability, or design debt +title: "[Tech debt]: " +labels: + - "type:technical-debt" + - "status:needs-design" +body: + - type: input + id: summary + attributes: + label: Summary + description: In one short sentence, what is the maintainability problem? + validations: + required: true + + - type: textarea + id: debt + attributes: + label: What is the problem? + description: Describe the cleanup or design issue. + validations: + required: true + + - type: textarea + id: evidence + attributes: + label: Evidence + description: Point to files, repeated patterns, confusing behavior, or review findings. + validations: + required: true + + - type: textarea + id: risk + attributes: + label: Risk + description: What gets harder or more fragile if this stays as it is? + validations: + required: true + + - type: textarea + id: direction + attributes: + label: Smallest useful cleanup + description: Describe the smallest change that would help. + + - type: textarea + id: verification + attributes: + label: How to verify + description: List the tests, docs, or review steps needed. diff --git a/.github/ISSUE_TEMPLATE/ux_improvement.md b/.github/ISSUE_TEMPLATE/ux_improvement.md deleted file mode 100644 index 5ccb7dd..0000000 --- a/.github/ISSUE_TEMPLATE/ux_improvement.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: UX improvement -about: Improve clarity, workflow, safety, or beginner experience. -title: "ux: " -labels: "type:ux, component:ux, status:needs-design" ---- - -## User workflow - -What is the user trying to do? - -## Current friction - -Describe what is confusing, unsafe, slow, or hard to verify. - -## Proposed improvement - -Describe the desired experience. - -## Safety and trust - -How should the user preview, approve, verify, or recover? - -## Done when - -- [ ] -- [ ] -- [ ] - -## Issue governance - -Apply the [Issue Governance Standard](../../docs/reference/ISSUE_GOVERNANCE.md) -during triage: - -- Priority label: -- Component label(s): -- Status label: -- Milestone: -- Related issues or pull requests: diff --git a/.github/ISSUE_TEMPLATE/ux_improvement.yml b/.github/ISSUE_TEMPLATE/ux_improvement.yml new file mode 100644 index 0000000..2ff4401 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ux_improvement.yml @@ -0,0 +1,53 @@ +name: UX improvement +description: Improve clarity, workflow, safety, or the beginner experience +title: "[UX]: " +labels: + - "type:ux" + - "component:ux" + - "status:needs-design" +body: + - type: input + id: summary + attributes: + label: Summary + description: In one short sentence, what should be easier or clearer? + validations: + required: true + + - type: textarea + id: workflow + attributes: + label: What are you trying to do? + description: Describe the task from the user's point of view. + validations: + required: true + + - type: textarea + id: friction + attributes: + label: What is confusing, unsafe, slow, or hard to check? + description: Describe what gets in the way today. Include the screen or step. + validations: + required: true + + - type: textarea + id: improvement + attributes: + label: What would be better? + description: Describe the experience you would like. + validations: + required: true + + - type: textarea + id: safety + attributes: + label: Safety and trust + description: How should the user preview, approve, check, or undo the result? + + - type: textarea + id: done-when + attributes: + label: Done when + placeholder: | + - ... + - ...