| file_type | documentation | ||||
|---|---|---|---|---|---|
| title | Instructions Directory | ||||
| description | Comprehensive instructions directory for LightSpeedWP development standards and practices | ||||
| version | v1.0 | ||||
| last_updated | 2025-10-24 | ||||
| maintainer | LightSpeed Engineering | ||||
| tags |
|
This directory contains comprehensive development instructions, standards, and guidelines that govern all LightSpeedWP projects and automation systems.
graph TB
A[Instructions Directory] --> B[🤖 Automation & AI]
A --> C[💻 Development Standards]
A --> D[🏗️ Architecture & Workflows]
A --> E[📚 Documentation & Communication]
A --> F[🔗 Integration & Security]
B --> B1[automation.instructions.md]
B --> B2[awesome-copilot.instructions.md]
B --> B3[automation.instructions.md]
B --> B4[automation-testing.instructions.md]
B --> B5[copilot.instructions.md]
C --> C1[coding-standards.instructions.md]
C --> C2[linting.instructions.md]
C --> C3[quality-assurance.instructions.md]
C --> C4[inline-docs.instructions.md]
D --> D1[workflows.instructions.md]
D --> D2[wordpress.instructions.md]
D --> D3[gitops.instructions.md]
E --> E1[docs.instructions.md]
E --> E2[documentation-formats.instructions.md]
F --> F1[security.instructions.md]
F --> F2[ci-cd.instructions.md]
G[Project Implementation] --> A
H[Agent Systems] --> B
I[Code Quality] --> C
J[Workflow Automation] --> D
K[Knowledge Management] --> E
style A fill:#e1f5fe
style B fill:#f3e5f5
style C fill:#e8f5e8
style D fill:#fff3e0
style E fill:#fce4ec
- Automation Instructions - Agents, labeling, release, metrics, planning, reporting, metadata
- Meta Instructions - Front matter, badges, references, quirky footers automation
- Copilot Instructions - GitHub Copilot configuration and usage
- Coding Standards Instructions - Unified coding standards across all projects
- Languages Instructions - JS/TS linting, JSON, YAML, JSDoc, Actions validation
- Quality Assurance Instructions - Testing pyramid, Jest, coverage, CI/CD
- Documentation Formats Instructions - Markdown, frontmatter, Mermaid, accessibility
- Security Instructions - Security best practices and standards
- Workflows Instructions - GitHub Actions and CI/CD standards
- Tools Instructions - Development tool configuration
- TaskSync Instructions - Task synchronization protocol
- Documentation Instructions - Documentation standards and practices
- Community Standards Instructions - File organisation, naming, README, saved replies
- Issues Instructions - Issue creation and management guidelines
- PR Creation Instructions - Pull request creation and management guidelines
- Inline TXT Instructions - Plain text documentation
- Inline XML Instructions - XML documentation standards
- Inline YAML Instructions - YAML inline documentation
- Documentation Formats Instructions - Markdown, frontmatter, Mermaid, accessibility
- Naming Conventions Instructions - File and variable naming
- Tagging and Frontmatter Conventions - Tagging standards
- File Management Guidelines - File organization standards
Instructions integrate with:
- Agents Directory - Automation implementation
- Workflows Directory - CI/CD implementation
- Prompts Directory - Structured AI prompts
- Reports Directory - Generated reports and artifacts
- Start with Core - Begin with core instruction categories for your domain
- Check Specializations - Look for technology-specific instructions
- Review Subdirectories - Explore specialized subdirectories for detailed guidance
- Cross-Reference - Use integration points to find related resources
- Follow Hierarchy - Apply general instructions before specific ones
- Check Dependencies - Ensure prerequisite instructions are followed
- Validate Compliance - Use automation to verify instruction adherence
- Update Regularly - Keep implementation current with instruction updates
- Version Control - Track instruction changes and their impact
- Automation Integration - Ensure instructions are reflected in automation
- Feedback Loop - Incorporate learnings back into instruction updates
- Cross-Reference Accuracy - Maintain accurate links between related instructions
Certain instructions are mandatory for all LightSpeedWP projects:
- Coding Standards - Must be followed in all code contributions
- Security Guidelines - Required for all production code
- Testing Standards - Minimum testing requirements must be met
- Documentation Standards - All code must meet documentation requirements
Many instructions are automatically enforced through:
- GitHub Actions - Workflow validation and compliance checking
- AI Agents - Automated review and correction
- Quality Gates - Automated blocking of non-compliant changes
- Metrics Collection - Continuous compliance monitoring
Instructions are tracked for:
- Adoption Rate - How widely instructions are followed
- Compliance Score - Automated compliance measurement
- Update Frequency - How often instructions are updated
- Community Feedback - User satisfaction and effectiveness ratings
This directory provides the foundation for consistent, high-quality development across the LightSpeedWP organization. See Automation Governance for enforcement policies.