XS✔ ◾ ✨ AI - Add Agents.md file with project standards and constraints

[Copilot]

0. AI Development - Prompt & Model (include prompts/models used or N/A)

Claude 3.7 Sonnet - Generated comprehensive agent documentation from codebase analysis (tsconfig, biome.json, source patterns)

1. What triggered this change? (PBI link, Email Subject, conversation + reason, etc)

GitHub Issue: Add Agents.md per SSW rule (https://www.ssw.com.au/rules/write-agents-md) and agents.md spec (https://agents.md/)

Follow-up requirement: Remove version field, add project context, guidelines, and guardrails sections

2. What was changed?

Created /AGENTS.md documenting agent metadata, capabilities, and development standards.

Sections added:

• Project Context & Knowledge Base: Architecture patterns (event-driven IPC, service-oriented, repository pattern), key components, documentation references

• Guidelines & Standards:

  • TypeScript: Strict mode, no any, interface vs type patterns, null safety with ?. and ??
  • Naming: kebab-case files, PascalCase components/types, camelCase functions, SCREAMING_SNAKE_CASE constants
  • Patterns: Structured error objects, async/await, Drizzle ORM transactions, React hooks for state

• Guardrails & Constraints:

  • Forbidden: any type, inline JSX functions, console.log in production, sync file operations
  • Security: Never commit/output API keys (including placeholders), Electron safeStorage for encryption, validate all input
  • Scope: No refactoring unrelated files, no fixing unrelated bugs, preserve backward compatibility

Technical details:

• Removed version field (tracked in RELEASE.md)
• 100-char line width, 2-space indent per Biome config
• References existing ADR, database README, and release notes

3. I paired or mob programmed with:

N/A

Original prompt

---

This section details on the original issue you should resolve

<issue_title>✨ AI - Add Agents.md file</issue_title>
<issue_description>Add Agents.md file as per rule:
https://www.ssw.com.au/rules/write-agents-md

https://agents.md/</issue_description>

<agent_instructions>read the rule content and generate agents.md</agent_instructions>

Comments on the Issue (you are @copilot in this section)

• Fixes SSWConsulting/SSW.YakShaver#3440

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[github-actions]

PR Metrics

✔ Thanks for keeping your pull request small.
✔ Thanks for adding tests.

	Lines
Product Code	-
Test Code	-
Subtotal	-
Ignored Code	530
Total	530

Metrics computed by PR Metrics. Add it to your Azure DevOps and GitHub PRs!

[github-actions]

🚀 Pre-release build is available for this PR:
https://github.com/SSWConsulting/SSW.YakShaver.Desktop/releases/tag/0.6.0-beta.680.1770628122

[github-actions]

🚀 Pre-release build is available for this PR:
https://github.com/SSWConsulting/SSW.YakShaver.Desktop/releases/tag/0.6.0-beta.680.1770628418

[Copilot]

Pull request overview

Adds a new AGENTS.md document to define AI agent/project context, development rules, standards, architecture patterns, and guardrails for the YakShaver Desktop codebase.

Changes:

• Introduces AGENTS.md with agent metadata, capabilities, and technical stack.
• Documents project structure + key backend/frontend architecture patterns.
• Defines development rules, testing guidance, and security/scope guardrails for contributors/agents.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[github-actions]

🚀 Pre-release build is available for this PR:
https://github.com/SSWConsulting/SSW.YakShaver.Desktop/releases/tag/0.6.0-beta.680.1770629242

[github-actions]

🚀 Pre-release build is available for this PR:
https://github.com/SSWConsulting/SSW.YakShaver.Desktop/releases/tag/0.6.0-beta.680.1770629608

[github-actions]

✅ Automated Release Created Successfully

Release Details:

• Version: 2026.2.12-BUILD.140.794b537
• Tag: 2026.2.12-BUILD.140.794b537
• Release: https://github.com/SSWConsulting/SSW.YakShaver.Desktop/releases/tag/2026.2.12-BUILD.140.794b537

You can monitor the build progress in the Actions tab.