Skip to content

fix: change default context filename from QWEN.md to AGENTS.md#2654

Open
qwen-code-dev-bot wants to merge 2 commits intomainfrom
fix/init-uses-agents-md
Open

fix: change default context filename from QWEN.md to AGENTS.md#2654
qwen-code-dev-bot wants to merge 2 commits intomainfrom
fix/init-uses-agents-md

Conversation

@qwen-code-dev-bot
Copy link
Copy Markdown
Collaborator

Fixes #2527

Changes

  • Changed DEFAULT_CONTEXT_FILENAME from QWEN.md to AGENTS.md in packages/core/src/tools/memoryTool.ts
  • Updated help text and comments to reflect the new default
  • Kept QWEN.md in the filename list for backward compatibility (reading both files still works)

Impact

Qwen Code Bot and others added 2 commits March 23, 2026 13:52
- Use scripts/get-release-version.js for version calculation
- Preview versions now use incrementing format (0.13.0-preview.N)
- Matches CLI release version format
- Fixes inconsistency between CLI and VSCode preview versions
- Update DEFAULT_CONTEXT_FILENAME to 'AGENTS.md' so /init command creates AGENTS.md
- Keep QWEN.md in the filename list for backward compatibility
- Update help text and comments to reflect the new default
@github-actions
Copy link
Copy Markdown
Contributor

📋 Review Summary

This PR changes the default context filename from QWEN.md to AGENTS.md to align with community best practices, while maintaining backward compatibility. The changes include updates to the memory tool constants, documentation strings, and a significant refactoring of the VSCode release workflow to use a centralized version management script.

🔍 General Feedback

  • The PR successfully addresses issue docs: rename QWEN.md to AGENTS.md to follow community best practices #2527 with a clean, backward-compatible approach
  • Two distinct changes are bundled: the filename change and workflow refactoring - consider if these should be separate PRs
  • The workflow refactoring significantly improves maintainability by centralizing version logic
  • Good attention to maintaining backward compatibility by keeping QWEN.md in the filename list

🎯 Specific Feedback

🟡 High

  • File: packages/core/src/tools/memoryTool.ts:88 - Inconsistent comment update: The comment on line 88 states "QWEN.md is first to maintain backward compatibility" but the actual array now has DEFAULT_CONTEXT_FILENAME (which is now AGENTS.md) first. This comment is outdated and should be updated to reflect that AGENTS.md is now first as the new default:
// Current (incorrect comment):
// QWEN.md is first to maintain backward compatibility (used by /init command and save_memory tool).

// Should be:
// AGENTS.md is first as the new default, QWEN.md is kept for backward compatibility.

Note: I see this is actually fixed in the diff at lines 88-89, but the current file still shows the old comment. Please verify the file was saved correctly.

🟢 Medium

  • File: packages/core/src/tools/memoryTool.ts:47, 73-74 - Documentation strings still reference QWEN.md in some places. The diff shows these should be updated to AGENTS.md:

    • Line 47: Parameter description mentions ~/.qwen/QWEN.md and project's QWEN.md
    • Lines 73-74: Tool description mentions ~/.qwen/QWEN.md and project's QWEN.md

    These are updated in the diff but verify they match the intended behavior.

  • File: .github/workflows/release-vscode-companion.yml:87-106 - The workflow refactoring removes the working-directory from the version step. Verify this is intentional since the get-release-version.js script is in the root scripts/ directory, not in packages/vscode-ide-companion/.

🔵 Low

  • File: packages/core/src/tools/memoryTool.ts:83-84 - Consider adding a deprecation notice or migration path documentation for users with existing QWEN.md files. While backward compatibility is maintained for reading, consider whether the /init command should mention both files or provide migration guidance.

  • File: .github/workflows/release-vscode-companion.yml - The refactored workflow uses a new script scripts/get-release-version.js. Consider adding a brief comment in the workflow explaining what the script does for future maintainers.

✅ Highlights

  • Excellent backward compatibility approach: Keeping both filenames in the array ensures existing users aren't disrupted
  • Smart workflow refactoring: Moving version logic to scripts/get-release-version.js significantly improves maintainability and reduces duplication in the workflow file
  • Clean separation of concerns: The script handles all version calculation logic (stable, preview, nightly, patch) in one place
  • Good use of shell scripting best practices: The workflow uses proper quoting, error handling, and environment variable passing
  • Well-documented script: The get-release-version.js script includes comprehensive JSDoc comments and clear error messages

@github-actions
Copy link
Copy Markdown
Contributor

Code Coverage Summary

Package Lines Statements Functions Branches
CLI N/A% N/A% N/A% N/A%
Core N/A% N/A% N/A% N/A%
CLI Package - Full Text Report
CLI full-text-summary.txt not found at: coverage_artifact/cli/coverage/full-text-summary.txt
Core Package - Full Text Report
Core full-text-summary.txt not found at: coverage_artifact/core/coverage/full-text-summary.txt

For detailed HTML reports, please see the 'coverage-reports-22.x-ubuntu-latest' artifact from the main CI run.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant