Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
159 changes: 159 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
name: Bug report
description: Report a defect or regression in an existing spod capability.
title: "[bug] "
body:
- type: markdown
attributes:
value: |
Use this form for behavior that is incorrect relative to an existing capability or documented contract.

Please avoid reporting missing/new capabilities as bugs; use the feature or use-case template instead.

- type: textarea
id: summary
attributes:
label: Summary
description: What is broken? Describe the defect in one or two clear paragraphs.
placeholder: The service accepts ... but then ...
validations:
required: true

- type: dropdown
id: area
attributes:
label: Area
description: Which part of spod is primarily affected?
options:
- Service orchestration
- CLI
- REST API
- Configuration / mission profiles
- Input resolution / ingestion
- POD workflow
- Products / artifacts
- QC / validation / reporting
- Provenance / manifests
- Deployment / Docker
- Observability
- Build / CI / tooling
- Documentation
- Other
validations:
required: true

- type: dropdown
id: severity
attributes:
label: Severity
description: What is the practical impact?
options:
- Critical — corrupt/invalid scientific or operational result without an explicit failure
- High — supported workflow is unusable or materially wrong
- Medium — degraded behavior with a workaround
- Low — minor defect or polish issue
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
description: What should happen according to the supported product behavior or documentation?
placeholder: |
Given ...
When ...
Then ...
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual behavior
description: What happens instead?
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Reproduction steps
description: Provide the smallest reliable sequence that reproduces the issue.
placeholder: |
1. Use config ...
2. Run ...
3. Inspect ...
4. Observe ...
validations:
required: true

- type: textarea
id: config
attributes:
label: Relevant configuration or input contract
description: Include the minimal relevant configuration. Remove secrets, credentials, and private data.
render: yaml

- type: textarea
id: evidence
attributes:
label: Evidence
description: Add logs, error output, artifact paths, numerical differences, screenshots, or hashes that demonstrate the issue.
placeholder: Paste concise evidence here.

- type: textarea
id: environment
attributes:
label: Environment
description: Include spod version/commit, Siderust version, Rust version, OS, container image, and deployment mode when relevant.
placeholder: |
spod:
Siderust:
Rust:
OS:
Deployment:
validations:
required: true

- type: dropdown
id: regression
attributes:
label: Regression?
description: Did this capability work previously?
options:
- "Yes"
- "No"
- Unknown
validations:
required: true

- type: textarea
id: capability_impact
attributes:
label: Product capability impact
description: Which documented workflow, use case, artifact, API contract, or product capability is affected?
placeholder: This breaks / degrades ...
validations:
required: true

- type: textarea
id: done
attributes:
label: Definition of fixed
description: State what must be true to close the bug, including the regression test or verification evidence.
placeholder: |
- [ ] Reproduction fails before the fix and passes after it.
- [ ] Existing product-level behavior remains unchanged.
- [ ] Relevant integration/E2E coverage is added.
validations:
required: true

- type: checkboxes
id: hygiene
attributes:
label: Checklist
options:
- label: I searched existing issues and did not find an equivalent report.
required: true
- label: I removed secrets, credentials, and private mission data from the report.
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
100 changes: 100 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
name: Documentation
description: Create, correct, or improve product, architecture, operational, or developer documentation.
title: "[docs] "
body:
- type: markdown
attributes:
value: |
Documentation is part of the product contract. Use this template when documentation is missing, stale, misleading, or insufficient to verify supported behavior.

- type: dropdown
id: kind
attributes:
label: Documentation type
options:
- Product / positioning
- Use case / workflow
- User guide / operations
- CLI / REST API
- Configuration / schema
- Architecture / ownership boundary
- Scientific assumptions / validation
- Deployment / observability
- Developer / contributing
- Examples
- Other
validations:
required: true

- type: textarea
id: problem
attributes:
label: Documentation problem
description: What is missing, wrong, stale, ambiguous, or difficult to verify?
validations:
required: true

- type: textarea
id: audience
attributes:
label: Audience
description: Who should be able to use this documentation?
placeholder: Operator, integrator, contributor, flight-dynamics engineer, reviewer, ...
validations:
required: true

- type: textarea
id: source_of_truth
attributes:
label: Source of truth
description: Which code, issue, schema, use case, standard, or external specification should the documentation agree with?
placeholder: |
- ...
- ...
validations:
required: true

- type: textarea
id: scope
attributes:
label: Required content
description: List the concepts, workflows, examples, limitations, or decisions the documentation must cover.
placeholder: |
- ...
- ...
validations:
required: true

- type: textarea
id: examples
attributes:
label: Examples / evidence
description: Include concrete commands, configs, API exchanges, artifacts, or diagrams that should be documented.

- type: textarea
id: acceptance
attributes:
label: Acceptance criteria
description: Define how reviewers can verify the documentation is complete and accurate.
placeholder: |
- [ ] ...
- [ ] No stale ownership/API claims remain.
- [ ] Commands/examples are executable or covered by tests where practical.
validations:
required: true

- type: textarea
id: related
attributes:
label: Related issues / use cases
description: Link the product capability or use case this documentation explains.

- type: checkboxes
id: hygiene
attributes:
label: Checklist
options:
- label: I checked current documentation for an existing canonical page before proposing a duplicate.
required: true
- label: This request identifies a source of truth rather than relying on undocumented assumptions.
required: true
Loading
Loading