Skip to content

docs: add GitHub issue & PR templates - #13

Merged
karlkauc merged 1 commit into
mainfrom
docs/issue-pr-templates
May 15, 2026
Merged

karlkauc merged 1 commit into
mainfrom
docs/issue-pr-templates

Conversation

@karlkauc

Copy link
Copy Markdown
Contributor

Adds repo-specific GitHub templates that steer reporters/contributors toward the conventions in CONTRIBUTING.md.

  • .github/ISSUE_TEMPLATE/bug_report.md — which component, FundsXML version & sample, exact command run, expected vs. actual, environment, and a "validation already done" checklist (XSD / xml_equiv).
  • .github/ISSUE_TEMPLATE/feature_request.md — what & why, where it fits, scope notes (XSD-valid, standalone, English, 4.0.0 quirk), contribute-a-PR?.
  • .github/ISSUE_TEMPLATE/config.yml — disables blank issues; links the Contributing guide and the upstream FundsXML schema repo.
  • .github/PULL_REQUEST_TEMPLATE.md — a checklist mirroring CONTRIBUTING.md (branched off fresh main, READMEs updated, XSD-valid, round-trip proven with xml_equiv + XSD, secure XML, CI green) plus a Verification section.

Docs/config only — no code or workflow changes. (This PR predates the template, so it doesn't self-apply.)

🤖 Generated with Claude Code

- .github/ISSUE_TEMPLATE/bug_report.md   — component, FundsXML version/sample,
  exact command, expected vs actual, env, validation-already-done checklist
- .github/ISSUE_TEMPLATE/feature_request.md — new sample/rule/language example,
  where it fits, scope notes pointing at CONTRIBUTING.md
- .github/ISSUE_TEMPLATE/config.yml — disable blank issues; link CONTRIBUTING
  and the upstream FundsXML schema repo
- .github/PULL_REQUEST_TEMPLATE.md — checklist mirroring CONTRIBUTING.md
  (fresh-main branch, READMEs updated, XSD-valid, round-trip xml_equiv+XSD,
  secure XML, CI green) + a Verification section

Docs/config only; no code or workflow changes.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@karlkauc
karlkauc merged commit ad04df9 into main May 15, 2026
2 checks passed
@karlkauc
karlkauc deleted the docs/issue-pr-templates branch May 15, 2026 20:26
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.

1 participant