Operations

This directory contains operational procedures, workflows, CI/CD documentation, and AI agent collaboration guidelines.

backlog-gatekeeper.md - Backlog management and prioritization process
workflow.md - Development workflow and branching strategy

Development Workflow

Standard Development Cycle

Branch: Create feature branch from master
Develop: Make changes, commit frequently
Test: make test - All 936+ tests must pass
Validate: Run DoE if physics changes
Review: Self-review or peer review
Merge: Merge to master when complete

Release Process

Tag release: git tag v1.x.x
Build all targets: make clean && make fastest
Run full test suite: make test
Validate determinism: ./starforth --doe
Generate documentation: make book
Create release artifacts

Build Targets

make                    # Standard optimized build
make fastest            # Maximum performance (ASM + LTO)
make pgo                # Profile-guided optimization
make debug              # Debug symbols
make test               # Run 936+ tests
make bench              # Quick benchmark

CI/CD (Future)

Planned automation:

Automated builds for all platforms (Linux, L4Re, StarKernel)
Test suite execution on every commit
DoE regression checks on physics changes
Release artifact generation
Documentation builds (PDF + HTML)

Deployment

Linux / L4Re

make PLATFORM=linux
./build/amd64/standard/starforth

StarKernel (Future)

make PLATFORM=kernel
# Creates starforth.efi (UEFI bootable image)
# Deploy to ESP: /boot/efi/EFI/BOOT/BOOTX64.EFI
# Or test with QEMU: qemu-system-x86_64 -bios OVMF.fd ...

AI Agent Collaboration

See ../AGENTS.md and ../AI_AGENT_MANDATORY_README.md for guidelines on working with AI coding assistants.

Task Management

Current task tracking: ../TASK_LIST.md (may be superseded by GitHub Issues after migration)

2.1 KiB Raw Permalink Blame History