Skip to content

Add AGENTS.md for AI coding agents - #44

Merged
frequency403 merged 1 commit into
developmentfrom
docs/agents-md
Nov 10, 2026
Merged

frequency403 merged 1 commit into
developmentfrom
docs/agents-md

Conversation

@frequency403

Copy link
Copy Markdown
Owner

Summary

Adds an AGENTS.md at the repo root with guidance for AI coding agents (and a compact reference for human contributors). The content comes from an analysis of the development branch, and its claims were checked against the source.

Changes Made

  • Bug fix (non-breaking change)
  • New feature (non-breaking change)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Refactoring (no functional change)

Contents of AGENTS.md:

  • Solution layout and tech stack (Avalonia 12, ReactiveUI + source generators, MS.Extensions.Hosting, Serilog, SSH.NET, xUnit v3)
  • Exact build, test, run and publish commands (always via OpenSSH_GUI.slnx or an explicit .csproj)
  • Architecture: startup, keyed View/ViewModel DI (RegisterViewWithViewModel naming rules), ResolveViewAsync, InitializeAsync(TParam), configuration, logging
  • Coding conventions: nullable, primary constructors, Central Package Management, compiled bindings, resx in both languages, DotSettings style
  • Security invariants: TOFU host key verification, key file permissions, in-process passphrase handling, backup/restore, SFTP modes
  • Testing guidelines, branch/versioning/commit/PR conventions, CI/release contract (asset names, pinned actions, secrets)
  • A "Known quirks" section and a Do/Don't checklist

Testing Performed

  • Tested on Windows (Version: _______)
  • Tested on macOS (Version: _______)
  • Tested on Linux (Version: _______)
  • Added unit tests (if applicable)
  • Verified no regression in existing functionality (documentation only)

Test Evidence

  • Documentation only, no code changes. Claims were cross-checked against the source by independent reviewers, with spot checks (e.g. the duplicate LoggingLevelSwitch registration, the SFTP 700/600 constants, resx key counts).

Questions for Reviewers

  • The Known quirks section points out possible issues instead of fixing them: the duplicate LoggingLevelSwitch registration, the stray OpenSSH_GUI.Testss.csproj, the missing de.resx key, outdated CONTRIBUTING.md instructions, and the unpermissioned file creation in FileSystemAnalyzer. Should any of these become their own issues?

Notes for Reviewers:

  • Priority: low
  • Breaking change: no

🤖 Generated with Claude Code

Documents solution layout, build/test commands, DI and MVVM patterns,
coding conventions, security invariants (TOFU, key file permissions,
passphrase handling, SFTP), testing guidelines, branch/versioning/CI
conventions and known quirks.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@frequency403
frequency403 merged commit ba905d4 into development Nov 10, 2026
3 checks passed
@frequency403
frequency403 deleted the docs/agents-md branch November 10, 2026 08:06
@frequency403 frequency403 mentioned this pull request Nov 10, 2026
6 of 7 tasks
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