NodetteHQ/PureXML
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases 1 Wiki Activity
93fd1f7815
PureXML/docs/rules
History
Mihaela Mihaljevic 0f3086c8e6 docs(roadmap): add Apple-palette mermaid roadmap and the roadmap gate 
Follow the mihaela-agents mermaid rule: add a README roadmap using the TileDown
Apple-color status classes (done/review/epic/todo), legend block first, then a
libxml2-parity roadmap showing shipped vs open work. Add docs/rules/mermaid.md
and scripts/check-roadmap.sh (wired into check-all.sh) so the diagrams stay
mechanically checkable.
2026-06-08 00:58:50 +02:00
..
code-style.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
commits.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
concurrency.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
cross-platform.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
dependency-injection.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
documentation.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
engineering.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
file-naming.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
folder-grouping.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
git-discipline.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
mermaid.md docs(roadmap): add Apple-palette mermaid roadmap and the roadmap gate 2026-06-08 00:58:50 +02:00
namespacing.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
package-architecture.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
package-structure.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
README.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
shared-protocols.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
systematic-debugging.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
testing-discipline.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
testing.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
verification.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00

README.md

PureXML Rules

Load these rules before changing code:

  • code-style.md
  • namespacing.md
  • cross-platform.md
  • testing.md
  • verification.md
  • commits.md

Project-specific overrides:

  • PureXML uses a root Package.swift.
  • Sources live directly under Sources.
  • Tests live in Tests (test target PureXMLTests).
  • Package.swift must keep dependencies: [].
  • Public API must live under the PureXML namespace tree.
  • The package must build on macOS, Linux, Windows, and WASI.

The broader rule files are retained for detailed guidance. When they include generic examples, apply the PureXML-specific overrides above.