Skip to content

Conversation

@mrz1836
Copy link
Collaborator

@mrz1836 mrz1836 commented Dec 22, 2025

What Changed

  • Reorganized technical convention documentation by removing 3 redundant files (sweep.yaml, ci-validation.md, governance-documents.md) and adding a new ai-compliance.md file
  • Updated 10 documentation and configuration files with normalized line endings and formatting improvements across .cursorrules, .github/.env.base, AGENTS.md, and all remaining tech convention markdown files
  • Consolidated CI validation and governance content into existing documentation to reduce duplication and improve maintainability
  • Modified mage-x.md, github-workflows.md, dependency-management.md, README.md, pull-request-guidelines.md, release-versioning.md, and security-practices.md with consistent formatting and content updates

Why It Was Necessary

  • Eliminates duplicate and overlapping documentation that could lead to conflicting guidance for contributors and AI agents
  • Streamlines the technical conventions structure by consolidating related content into fewer, more comprehensive files
  • Ensures consistent formatting and line endings across all configuration and documentation files for better version control and readability
  • The addition of ai-compliance.md provides a dedicated reference for AI agent behavior expectations, separating concerns from the general agent guidelines

Testing Performed

  • Verified markdown syntax and formatting of all modified documentation files
  • Validated that removed files (sweep.yaml, ci-validation.md, governance-documents.md) had their essential content preserved in other documentation
  • Confirmed .cursorrules and .github/.env.base maintain valid configuration syntax after line ending normalization
  • Reviewed diff to ensure no critical content was lost during the reorganization and that all line changes represent formatting improvements rather than substantive alterations

Impact / Risk

  • Low Risk: Primary changes are documentation restructuring and formatting normalization with no code modifications
  • No Breaking Changes: Configuration files maintain their functional content; only formatting and organization improved
  • Positive Impact: Reduced documentation surface area makes conventions easier to navigate and maintain
  • Migration: Contributors may need to reference new file locations, but all essential guidance remains accessible in consolidated documents

@mrz1836 mrz1836 self-assigned this Dec 22, 2025
@mrz1836 mrz1836 added automated-sync Automated sync PR, e.g. from a fork or external repo automerge Label to automatically merge pull requests that meet all required conditions chore Simple dependency updates or version bumps labels Dec 22, 2025
@github-actions github-actions bot added size/XL Very large change (>500 lines) update General updates labels Dec 22, 2025
@sonarqubecloud
Copy link

@mrz1836 mrz1836 merged commit ac646d8 into master Dec 22, 2025
45 checks passed
@github-actions github-actions bot deleted the chore/sync-files-bsv-blockchain-20251222-112310-c8d31f6 branch December 22, 2025 17:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated-sync Automated sync PR, e.g. from a fork or external repo automerge Label to automatically merge pull requests that meet all required conditions chore Simple dependency updates or version bumps size/XL Very large change (>500 lines) update General updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants