From add063e4c7e895c90722a808d8b7355ea1760e66 Mon Sep 17 00:00:00 2001 From: Karl Kauc Date: Fri, 15 May 2026 22:25:52 +0200 Subject: [PATCH] docs: add GitHub issue & PR templates MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - .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) --- .github/ISSUE_TEMPLATE/bug_report.md | 29 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 ++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 29 +++++++++++++++++++++++ 4 files changed, 89 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..af37e70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: An example doesn't run, or validation/round-trip is wrong +title: "[bug] " +labels: bug +--- + +**Which example / component** +e.g. `Database_Integration/python/export_fundsxml.py`, `XSD_Validation/java`, +`XSLT_Transformations/Factsheet`, the Schematron ruleset, … + +**FundsXML version & sample** +e.g. 4.2.9, `FundsXML_Files/4.2.9/positions/Mixed-Fund_Positions.xml` +(or attach/inline a minimal FundsXML snippet — no real/PII data). + +**What I ran** +The exact command(s), including any `tools/fetch-schema.sh` / +`tools/fetch-tools.sh` step. + +**Expected vs. actual** +What you expected and what happened (paste the full error / output). + +**Environment** +OS; and the relevant runtime version: Python / Java (`java -version`) / +Node (`node -v`) / .NET (`dotnet --version`) / `xmllint --version`. + +**Validation already done** (helps a lot) +- [ ] `xmllint --noout --schema .schema-cache//FundsXML.xsd ` result: … +- [ ] round-trip checked with `Database_Integration/tools/xml_equiv.py` (if applicable): … diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..4479434 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Contributing guide + url: https://github.com/fundsxml/examples/blob/main/CONTRIBUTING.md + about: Conventions, local verification and the PR workflow — read first. + - name: FundsXML standard & schema + url: https://github.com/fundsxml/schema + about: Questions about the FundsXML standard or XSD itself (not this repo). diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..738037a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: New example / enhancement +about: Propose a new sample, rule, language example or improvement +title: "[feat] " +labels: enhancement +--- + +**What & why** +The use case and who it helps (e.g. "import example in Go", "PRIIPS-KID +regulatory sample", "Schematron rule for X"). + +**Where it fits** +Which area: `FundsXML_Files/`, `XSD_Validation/`, `Schematron_…`, +`XSLT_…`, `XQuery_Examples/`, `XML_Signature/`, `Database_Integration/`, +`Large_File_Processing/`, `Data_Binding_JSON/`. + +**Scope notes (per [CONTRIBUTING.md](../../CONTRIBUTING.md))** +- FundsXML version(s) involved; remember 4.0.0 has no `ControlData/Version`. +- Standalone & runnable (no DB server / Docker); English; teaching-grade comments. +- New samples must be XSD-valid against the official released schema; new + round-trip examples must be proven with `xml_equiv.py` **+** XSD. + +**Willing to contribute a PR?** yes / no diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..5dc6758 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,29 @@ + + +## What & why + + + +## Area + + + +## Checklist (see [CONTRIBUTING.md](../CONTRIBUTING.md)) + +- [ ] Branched off the **latest `main`** (not stacked on another open PR). +- [ ] One focused change; relevant **README(s) updated** in this PR. +- [ ] English only; example is **self-contained** and **heavily commented** + (file-header: purpose / run / deps / FundsXML assumptions + what & why). +- [ ] FundsXML conventions: no XML namespace; XSD-validated against the + **official released schema** via `tools/fetch-schema.sh`; 4.0.0 has no + `ControlData/Version`; secure XML parsing (DTD/external entities off). +- [ ] New/changed samples are **XSD-valid**; negative fixtures still fail. +- [ ] Round-trip examples: proven with `Database_Integration/tools/xml_equiv.py` + **and** `xmllint --schema` (complementary checks). +- [ ] Schematron/XSLT tolerance or pattern changes mirrored on both sides + + both READMEs. +- [ ] **CI is green** (`.github/workflows/ci.yml` — validates everything). + +## Verification + +