Skip to content

docs: add GitHub issue templates for bug reports and feature requests (closes #1) - #68

Open
ghzhost wants to merge 1 commit into
forthfate:mainfrom
ghzhost:feat/github-issue-templates
Open

ghzhost wants to merge 1 commit into
forthfate:mainfrom
ghzhost:feat/github-issue-templates

Conversation

@ghzhost

@ghzhost ghzhost commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Closes #1

Goal

Add clear, structured GitHub issue templates (using YAML form schemas) that help contributors report reproducible bugs and propose new features with appropriate details and labels.

Scope

  • Added .github/ISSUE_TEMPLATE/bug_report.yml:
    • Captures problem description, reproduction steps, expected vs actual behavior, environment & versions (OS, Python, Node, OpenOrbit), and optional logs/screenshots.
    • Automatically tags new submissions with bug.
  • Added .github/ISSUE_TEMPLATE/feature_request.yml:
    • Captures problem statement/motivation, proposed solution/behavior, alternatives considered, and additional context.
    • Automatically tags new submissions with enhancement.
  • Kept templates clean, concise, and structured according to standard GitHub issue form specifications.

Validation

  • Verified YAML syntax validity and schema keys.
  • Ran git diff --check cleanly.
  • Validated test suite (PYTHONPATH=. pytest tests/).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add GitHub issue templates

1 participant