NodetteHQ/PureYAML
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity
28c89f3713
PureYAML/docs/rules
History
Mihaela Mihaljevic 1dc986f146 docs(readme): retire the stale Mermaid roadmap and its dead CI gate 
The roadmap diagrams referenced issue numbers (#1, #8-#13, #43-#55) that no
longer exist on Codeberg: the GitHub to Codeberg migration reset this repo's
issue tracker, and those numbers were never re-created. scripts/check-roadmap.sh
existed only to keep that roadmap in sync with GitHub epic-labeled issues via
gh, which can't resolve a Codeberg/Forgejo repo anyway, so the gate had been a
silent no-op since the move. Removed the roadmap section, the gate script, its
two call sites, and its now-pointless rule doc, and pointed the remaining
work at the real, live issues (#4, #5, #6, #7, tracked under epic #8). Also
fixed two leftover Mihaela/PureYAML references in docs/RELEASE.md.
2026-07-09 23:38:23 +02:00
..
code-style.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
colors.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
commits.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
components.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
concurrency.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
cross-platform.md ci: use checkout action with node 24 2026-06-06 00:32:53 +02:00
dependency-injection.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
documentation.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
engineering.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
file-naming.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
folder-grouping.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
fonts.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
git-discipline.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
linux-server.md ci: use checkout action with node 24 2026-06-06 00:32:53 +02:00
namespacing.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
package-architecture.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
package-import-contract.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
package-structure.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
README.md fix(ci): prepare 0.1.0 release 2026-06-05 21:20:20 +02:00
research-compatibility.md fix(parser): match block continuation parsing 2026-06-05 22:12:12 +02:00
shared-protocols.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
systematic-debugging.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
testing-discipline.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
testing.md test(validation): harden diagnostics corpus 2026-06-05 10:46:28 +02:00
validation.md Harden parser against real YAML fixtures 2026-06-05 19:34:30 +02:00
verification.md fix(ci): prepare 0.1.0 release 2026-06-05 21:20:20 +02:00
view-models.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00
views.md feat(package): bootstrap pure swift yaml package 2026-06-05 06:34:20 +02:00

README.md

PureYAML Rules

Load these rules before changing code:

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

Project-specific overrides:

  • PureYAML uses a root Package.swift.
  • Sources live directly under Sources.
  • Tests live in Tests/PureYAMLTests.
  • Package.swift must keep dependencies: [].
  • Public API must live under the PureYAML 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 PureYAML-specific overrides above.