Contributing¶
Contributions are welcome. go-ruby-xslt/xslt is built to a small set of
non-negotiable rules — they are what keep it pure-Go, correct, and faithful to
XSLT 1.0. Please read these before opening a pull request.
Hard rules¶
- Build from source — no vendoring. Everything compiles from source. Being able to compile from source is a guarantee of independence.
- 100% test coverage target, enforced in CI. New code ships with tests, and coverage is a CI gate. Fill the error branches, not just the happy path.
- All GitHub content in English. Issues, pull requests, commits, comments, and discussions are English-only.
- Golden vectors + differential testing. Correctness is defined by the
XSLT 1.0 spec and reference Ruby. Deterministic golden vectors hold coverage
with no Ruby present; a differential oracle runs the corpus through both
Nokogiri::XSLT(libxslt) and this library and compares the results byte-for-byte — not approximated from memory. - Pure Go, cgo disabled. The whole point is a single static binary with no C
toolchain and no libxslt. Code must build with
CGO_ENABLED=0. If a feature seems to need C, it needs a pure-Go path instead. - Built on go-ruby-nokogiri, not a second XPath engine. The XPath 1.0 engine is go-ruby-nokogiri's, driven through its extension seam. Anything that needs a live Ruby binding belongs in the consumer, not here.
Workflow¶
- Pick or open an issue describing the change.
- Work test-first: add the golden / differential / unit tests, then make them pass.
-
Run the full suite with coverage and confirm the gate is green:
-
Open a PR in English, referencing the issue.
Where things live¶
The library is in
github.com/go-ruby-xslt/xslt. This
documentation site is in
github.com/go-ruby-xslt/docs. Start
from the Usage & API page and the Roadmap to find the
right place for your change.