singularity/singularity-forge
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

feat: deprecate agent-instructions.md in favor of AGENTS.md / CLAUDE.md (#1492) (#1514)

Browse source 
Replace loadAgentInstructions() with a deprecation warning that fires when
legacy agent-instructions.md files are detected. Pi core already supports
AGENTS.md (with CLAUDE.md fallback) per directory, making the custom GSD
mechanism redundant.

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
TÂCHES 2026-03-19 17:47:06 -06:00 • committed by GitHub
parent bae9cf83ba
commit c680e2d90c
2 changed files with 22 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -455,7 +455,9 @@ auto_report: true
### Agent Instructions
Create an `agent-instructions.md` file in your project root to inject persistent per-project behavioral guidance into every agent session. This file is loaded automatically and provides project-specific context the LLM should always have — coding standards, architectural decisions, domain terminology, or workflow preferences.
Place an `AGENTS.md` file in any directory to provide persistent behavioral guidance for that scope. Pi core loads `AGENTS.md` automatically (with `CLAUDE.md` as a fallback) at both user and project levels. Use these files for coding standards, architectural decisions, domain terminology, or workflow preferences.
> **Note:** The legacy `agent-instructions.md` format (`~/.gsd/agent-instructions.md` and `.gsd/agent-instructions.md`) is deprecated and no longer loaded. Migrate any existing instructions to `AGENTS.md` or `CLAUDE.md`.
### Debug Mode

50
src/resources/extensions/gsd/index.ts
View file

@ -66,32 +66,24 @@ import { toPosixPath } from "../shared/mod.js";
import { isParallelActive, shutdownParallel } from "./parallel-orchestrator.js";
import { DEFAULT_BASH_TIMEOUT_SECS } from "./constants.js";
// ── Agent Instructions ────────────────────────────────────────────────────
// Lightweight "always follow" files injected into every GSD agent session.
// Global: ~/.gsd/agent-instructions.md Project: .gsd/agent-instructions.md
// Both are loaded and concatenated (global first, project appends).
// ── Agent Instructions (DEPRECATED) ──────────────────────────────────────
// agent-instructions.md is deprecated. Use AGENTS.md or CLAUDE.md instead.
// Pi core natively supports AGENTS.md (with CLAUDE.md fallback) per directory.
function loadAgentInstructions(): string | null {
const parts: string[] = [];
const globalPath = join(homedir(), ".gsd", "agent-instructions.md");
if (existsSync(globalPath)) {
try {
const content = readFileSync(globalPath, "utf-8").trim();
if (content) parts.push(content);
} catch { /* non-fatal — skip unreadable file */ }
function warnDeprecatedAgentInstructions(): void {
const paths = [
join(homedir(), ".gsd", "agent-instructions.md"),
join(process.cwd(), ".gsd", "agent-instructions.md"),
];
for (const p of paths) {
if (existsSync(p)) {
console.warn(
`[GSD] DEPRECATED: ${p} is no longer loaded. ` +
`Migrate your instructions to AGENTS.md (or CLAUDE.md) in the same directory. ` +
`See https://github.com/gsd-build/GSD-2/issues/1492`,
);
}
}
const projectPath = join(process.cwd(), ".gsd", "agent-instructions.md");
if (existsSync(projectPath)) {
try {
const content = readFileSync(projectPath, "utf-8").trim();
if (content) parts.push(content);
} catch { /* non-fatal — skip unreadable file */ }
}
if (parts.length === 0) return null;
return parts.join("\n\n");
}
// ── Depth verification state ──────────────────────────────────────────────
@ -682,12 +674,8 @@ export default function (pi: ExtensionAPI) {
}
}
// Load agent instructions (global + project)
let agentInstructionsBlock = "";
const agentInstructions = loadAgentInstructions();
if (agentInstructions) {
agentInstructionsBlock = `\n\n## Agent Instructions\n\nThe following instructions were provided by the user and must be followed in every session:\n\n${agentInstructions}`;
}
// Warn if deprecated agent-instructions.md files are still present
warnDeprecatedAgentInstructions();
const injection = await buildGuidedExecuteContextInjection(event.prompt, process.cwd());
@ -732,7 +720,7 @@ export default function (pi: ExtensionAPI) {
].join("\n");
}
const fullSystem = `${event.systemPrompt}\n\n[SYSTEM CONTEXT — GSD]\n\n${systemContent}${preferenceBlock}${agentInstructionsBlock}${knowledgeBlock}${memoryBlock}${newSkillsBlock}${worktreeBlock}`;
const fullSystem = `${event.systemPrompt}\n\n[SYSTEM CONTEXT — GSD]\n\n${systemContent}${preferenceBlock}${knowledgeBlock}${memoryBlock}${newSkillsBlock}${worktreeBlock}`;
stopContextTimer({
systemPromptSize: fullSystem.length,
injectionSize: injection?.length ?? 0,