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
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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/<ver>/FundsXML.xsd <file>` result: …
- [ ] round-trip checked with `Database_Integration/tools/xml_equiv.py` (if applicable): …
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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).
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!-- Thanks for contributing! Please read CONTRIBUTING.md first. -->

## What & why

<!-- One or two sentences: what this changes and the use case it serves. -->

## Area

<!-- e.g. Database_Integration/python, XSLT_Transformations, a new sample, … -->

## 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

<!-- The exact commands you ran and their result. No "should pass". -->