Skip to content

Clarify and enforce rules for managed and retired files#70

Merged
Trawis merged 1 commit into
developfrom
feature/docs-4.0.1
Jul 7, 2026
Merged

Clarify and enforce rules for managed and retired files#70
Trawis merged 1 commit into
developfrom
feature/docs-4.0.1

Conversation

@Trawis

@Trawis Trawis commented Jul 7, 2026

Copy link
Copy Markdown
Owner

Update documentation and sync-docs.py to clarify which documents to generate by project type and to explicitly handle project-owned files, especially under .github/workflows. Add stricter validation in migration config to prevent collisions between managed, protected, retired, and scaffolded paths, including new support for explicit retired assets with content hashes. Enhance managed state loader to recognize and validate retired asset hashes. Increment version numbers to reflect these changes.

Pull Request

Summary

Changes

Requirements / Spec Alignment

  • FSD reviewed if provided
  • TSD reviewed if provided
  • GDD reviewed if game-related and provided
  • Acceptance criteria / issue / ticket reviewed if provided
  • Conflicts or unclear requirements reported

Documentation

  • README.md updated if needed
  • CHANGELOG.md updated if needed
  • FEATURES.md updated if needed
  • docs/ updated if needed
  • No invented features, claims, screenshots, benchmarks, or compatibility guarantees

Validation

  • Build ran or skip reason documented
  • Unit tests added/updated where feasible
  • Tests ran or skip reason documented
  • Smoke/manual check ran where practical
  • Format/lint checks ran where configured
  • Implementation rechecked against task/specs/changed files

Branching / Merge Safety

  • Work was done on a task branch
  • Branch name follows feature/<short-kebab-description>, release/<version>, or hotfix/<short-kebab-description>
  • Branch family follows strict Git Flow
  • PR targets the correct Git Flow branch
  • No auto-merge requested/performed
  • No branch protection bypass requested/performed

Notes / Risks

Update documentation and sync-docs.py to clarify which documents to generate by project type and to explicitly handle project-owned files, especially under .github/workflows. Add stricter validation in migration config to prevent collisions between managed, protected, retired, and scaffolded paths, including new support for explicit retired assets with content hashes. Enhance managed state loader to recognize and validate retired asset hashes. Increment version numbers to reflect these changes.
@Trawis Trawis merged commit cde1647 into develop Jul 7, 2026
2 of 3 checks passed
@Trawis Trawis deleted the feature/docs-4.0.1 branch July 7, 2026 06:13
@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 31 complexity · 0 duplication

Metric Results
Complexity 31
Duplication 0

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant