docs: add top-level CONTRIBUTING.md - #12
Merged
Merged
Conversation
Captures the conventions enforced throughout the repo so contributors get them right up front: English-only teaching-grade examples, no XML namespace, XSD validation against the official release via tools/fetch-schema.sh, 4.0.0 has no ControlData/Version, Schematron tolerance/pattern rules, secure XML parsing, round-trip proven by xml_equiv + XSD, local verification commands, toolchain gotchas (SchXslt fat-jar classpath, WebDAV .DS_Store), and the branch-off-fresh-main / no-stacked-PRs / maintainer-merges workflow. README Contributing section now links to it. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a top-level
CONTRIBUTING.mdand links it from the README's Contributing section.It distils the conventions this repo actually enforces (so contributors don't learn them via review):
tools/fetch-schema.sh; 4.0.0 has noControlData/Version; Position↔Asset byUniqueID; keep Schematron/XSLT tolerances in sync; ISO Schematron first-match-per-pattern rule; secure XML parsing everywhere.xml_equiv.pyand XSD (complementary, sincexml_equivignoresxmlns); author round-trip fixtures lossless..DS_Store).main, no stacked PRs (repo auto-deletes head branches on merge), CI must be green, a maintainer merges.Docs-only; no code or workflow changes.
🤖 Generated with Claude Code