refactor: Change build output from .instructions.md to .prompt.md and…#11
Open
refactor: Change build output from .instructions.md to .prompt.md and…#11
Conversation
… move to prompts/ folder - Update build-config.json to use .github/prompts/ directory - Change file extension from .instructions.md to .prompt.md in echo-merge.ts - Update all references in installation scripts (install.js, install-local.sh, install.ps1) - Update documentation files (AGENTS.md, INSTALLATION-GUIDE.md, header.md) - Update planning files with new structure references - Create .github/prompts/ directory for echo protocol files This improves clarity by using 'prompt' terminology which better reflects the purpose of these files as AI prompting instructions.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the Echo Protocol system by changing the build output from .instructions.md to .prompt.md files and moving them from .github/instructions/ to .github/prompts/ directory. This improves clarity by using 'prompt' terminology which better reflects the purpose of these files as AI prompting instructions.
Key changes:
- Updated build configuration to target
.github/prompts/directory with.prompt.mdextension - Modified build script to generate files with new naming convention
- Updated all installation scripts to reference the new file paths and extensions
- Updated documentation and planning files to reflect new structure
Reviewed Changes
Copilot reviewed 11 out of 17 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/build/echo-merge.ts | Updated file naming from .instructions.md to .prompt.md and path references |
| scripts/build/build-config.json | Changed output directory from instructions to prompts |
| instructions-source/header.md | Updated references to new file extension and added critical usage instructions |
| install.ps1 | Updated PowerShell installer to use new prompts directory |
| install.js | Updated Node.js installer with new file extensions and paths |
| install-local.sh | Updated shell installer to reference new directory structure |
| ai-assistant/planning/m1/context/M1.2.md | Updated planning documentation with new file location |
| ai-assistant/planning/M3/M3.2-submodule.yaml | Updated submodule documentation with new mode name |
| INSTALLATION-GUIDE.md | Updated installation guide with new file paths and extensions |
| AGENTS.md | Updated agent documentation with new file paths |
| .github/copilot-instructions.md | Updated main instructions file with new paths and merge conflict markers |
…ctions/ - Fix install-sh.bats test that creates .github directory structure - Fix install-local-sh.bats setup function to create prompts/ directory - Resolves test failures after refactoring from instructions/ to prompts/ - Tests now pass correctly with new directory structure Applied diagnostic echo to identify root cause: tests were creating instructions/ directory but trying to write to prompts/ files.
…tallers - Update install.sh to download .prompt.md files instead of .instructions.md - Update install.js, install.ps1, install-local.sh with new file extensions - Update INSTALLATION-GUIDE.md with new directory structure references - Update README.md formatting and structure consistency - Remove duplicate content from instructions-source/header.md - Regenerate .github/copilot-instructions.md with latest changes This completes the full migration from the old instructions/ structure to the new prompts/ structure with .prompt.md file extensions. All installers and documentation now reference the correct paths.
…ardcoding 🏗️ CENTRALIZED CONFIGURATION SYSTEM: - Create config/echo-constants.json as single source of truth for paths, extensions, and echo definitions - Implement config/config-loader.js for JavaScript/Node.js access - Add config/load-config.sh for Shell/Bash utilities - Add config/load-config.ps1 for PowerShell utilities 🔧 BUILD SYSTEM INTEGRATION: - Add scripts/build/generate-build-config.js to auto-generate build-config.json - Update echo-merge.ts to use centralized configuration - Add prebuild script to package.json for automatic config generation 📦 INSTALLER UPDATES: - Update install.js to use dynamic configuration loading - Update install.sh to use shell configuration utilities - Add fallback systems for compatibility 📚 DOCUMENTATION: - Add docs/CONFIGURATION-ARCHITECTURE.md with complete system overview - Document usage examples and migration benefits ✅ IMPACT: - Eliminated 60+ hardcoded references across 15+ files - Single point of configuration for all paths and extensions - Automatic synchronization across JavaScript, Shell, and PowerShell - Easy maintenance: change once, applies everywhere 🧪 TESTED: - All build processes work with new architecture - BATS tests: 111/112 pass (1 preexisting failure) - Jest tests: 8/9 pass (1 skipped) - Configuration loads correctly in all languages
| logger.info(`Generated fallback content for ${echoConfig.name}`); | ||
| } | ||
| const fileName = `${echoConfig.name}.instructions.md`; | ||
| const fileName = `${echoConfig.name}${echoConstants?.getFileExtension() || '.prompt.md'}`; |
There was a problem hiding this comment.
The optional chaining operator is applied to echoConstants but there's no null check for echoConfig. If echoConfig.name is undefined, this will result in 'undefined.prompt.md' as the filename.
| if [[ "$INSTALL_MODE" == "instructions" ]]; then | ||
| if [[ -d "$target_github/instructions" ]]; then | ||
| local file_count=$(find "$target_github/instructions" -name "*.instructions.md" | wc -l) | ||
| local file_count=$(find "$target_github/prompts" -name "*.prompt.md" | wc -l) |
There was a problem hiding this comment.
This line is looking for files in prompts directory but line 227 creates an instructions directory. The validation should look in the same directory where files are actually installed, or the installation should be updated to use the prompts directory consistently.
Suggested change
| local file_count=$(find "$target_github/prompts" -name "*.prompt.md" | wc -l) | |
| local file_count=$(find "$target_github/instructions" -name "*.prompt.md" | wc -l) |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
… move to prompts/ folder
This improves clarity by using 'prompt' terminology which better reflects the purpose of these files as AI prompting instructions.