Document Windows compatibility practices in IMPLEMENTATION_PHILOSOPHY.md #12
Conversation
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
Add comprehensive guidance for cross-platform development with focus on Windows compatibility. This documents critical patterns discovered from fixing production issues: 1. **File I/O Encoding**: Always specify encoding="utf-8" explicitly - Windows defaults to cp1252/charmap instead of UTF-8 - Prevents "'charmap' codec can't decode" errors - Applies to open(), Path.read_text(), Path.write_text() 2. **Path Sanitization**: Remove Windows-prohibited characters - Colons, pipes, asterisks, etc. cause [WinError 267] - Agent names like "foundation:explorer" must be sanitized - Applies to any user input used in filenames 3. **Development Checklist**: Pre-commit verification steps This guidance is loaded by all agents via common-agent-base.md, ensuring consistent Windows-safe code across the codebase. Related PRs: - amplifier-app-cli#36 (encoding fixes) - Merged - amplifier-foundation#11 (test coverage) - Open Type: docs 🤖 Generated with [Amplifier](https://github.com/microsoft/amplifier) Co-Authored-By: Amplifier <240397093+microsoft-amplifier@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Context
This PR adds a dedicated "Windows Development Compatibility" section to the implementation philosophy document. The guidelines cover critical areas like path separators, filesystem restrictions (colons in filenames), case sensitivity differences, and best practices for cross-platform development.
These guidelines emerged from real compatibility issues encountered during development and testing, making them practical and actionable for contributors.
Test plan
🤖 Generated with Amplifier
Co-Authored-By: Amplifier 240397093+microsoft-amplifier@users.noreply.github.com