NodetteHQ/PureYAML
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity
main
PureYAML/docs/rules-swift/PROVENANCE.md
Mihaela M 5f3892f2c1 chore(rules): vendor the rules-swift canon into docs/rules-swift 
Mirror the shared Swift rules canon (rules-swift, commit 4ebb892) into
docs/rules-swift/ as a read-only reference alongside the repo's tailored
docs/rules/. PROVENANCE.md records the source, commit, and what was
included or excluded; the upstream repo's own VCS, CI, and lint tooling
is omitted as machinery rather than rule content.

Exclude the vendored tree from the style gate (scripts/check-style.sh)
and the pre-commit hook: the canon's enforcement docs quote the
forbidden attribution phrases to define them, the same reason the
repo's own enforcement files are already excluded.
2026-06-26 05:36:12 +02:00

1.6 KiB
Raw Permalink Blame History

Vendored: rules-swift canon

This directory is a vendored, read-only mirror of the shared Swift rules canon. Do not edit files here. Change the rules upstream, then re-vendor.

Source

What is included

The rule content verbatim: every top-level rule document plus the core/, exp/, ui/, and scripts/ subtrees, and the upstream README.md, CONTRIBUTING.md, CONVENTIONS.md, CHANGELOG.md, and LICENSE for context and attribution.

What is excluded

The upstream repository's own VCS, CI, and tooling configuration, which is that repository's machinery rather than rule content and would conflict with PureYAML's own setup:

  • .git/, .github/, .githooks/
  • .gitignore, .pre-commit-config.yaml
  • .swiftformat, .swiftlint.yml

Style-gate exclusion

The whole tree is excluded from PureYAML's style gate (scripts/check-style.sh) and the .githooks/pre-commit hook. The canon's own enforcement documents (core/git-discipline.md, core/commits.md) quote the forbidden AI-attribution phrases in order to define and detect them, the same reason PureYAML excludes its own enforcement files from the scan.

Relationship to docs/rules/

docs/rules/ holds PureYAML's tailored, repo-specific rule set, which is what CLAUDE.md and AGENTS.md point coding agents to. This docs/rules-swift/ tree is the upstream canon those tailored rules derive from, kept for reference and audit.