Skip to content

AGENTS.md

Latest commit

 

History

History
53 lines (45 loc) · 3.21 KB

AGENTS.md

File metadata and controls

53 lines (45 loc) · 3.21 KB

Repository Guidelines

Environment

  • OS: Windows
  • Shell: Use Command Prompt (cmd.exe) only; avoid Bash/Unix commands
  • Tools: Visual Studio 2026 (v18) and appropriate .NET SDKs starting with net472
  • Build scripts are Windows .cmd files under Scripts/
  • Do not run build scripts unless instructed to do so

Project Structure & Module Organization

  • Source/Testing/Krypton Components: Core libraries (Krypton.Toolkit, Krypton.Ribbon, Krypton.Navigator, Krypton.Workspace, Krypton.Docking) and the solution Krypton Toolkit Suite - VS2022.sln
  • Source/Testing/Krypton Components/TestForm: WinForms sample app used to validate changes
  • Source/Testing/TestHarnesses: Small repro/test harnesses (e.g., ThemeSwapRepro)
  • Scripts//Testing/: Build and packaging scripts (build-stable.cmd, build-canary.cmd, build-nightly.cmd, build.proj)
  • Artefacts/: Build outputs by configuration (e.g., Artefacts/Debug)
  • Documents/, Assets/, Logs/: Docs, images, and build logs

Build, Test, and Development Commands

  • Build solution (Debug):
    • dotnet build "Source/Testing/Krypton Components/Krypton Toolkit Suite - VS2022.sln" -c Debug
  • Run sample app:
    • dotnet run --project "Source/Testing/Krypton Components/TestForm/TestForm.csproj" -c Debug
  • Preset builds (Windows cmd):
    • Scripts/Testing/build-stable.cmd | Scripts/Testing/build-canary.cmd | Scripts/Testing/build-nightly.cmd
  • Outputs land in Artefacts/<Configuration>/. Supported TFMs include net472, net48, net481, net8.0-windows, net9.0-windows, net10.0-windows, net11.0-windows

Coding Style & Naming Conventions

  • Line endings/encoding: CRLF, UTF-8 with BOM
  • Follow Source/.editorconfig and project analyzers (EnableNETAnalyzers=true)
  • Indentation: 4 spaces; line endings: CRLF
  • Projects use global using like in GlobalDeclarations.cs, do not add new usings in other files
  • Before adding new variables check for existing ones
  • No variable aliasing

C# Rules

  • Surgical edits: preserve structure, identifiers, and existing comments; avoid adding defensive checks unless asked
  • No unneeded try/catch blocks if there's no catch handling
  • Idioms: use null-propagation and object/collection initializers where consistent
  • Compatibility: ensure changes build for net472 and C# 7.3
  • WinForms: UseWindowsForms=true; prefer designer-friendly patterns and keep partial classes tidy
  • WinForms designer: keep object declarations at file bottom; initialize in *.Designer.cs InitializeComponent()
  • Constraint: do not use yield return inside catch blocks

Testing Guidelines

  • No formal unit test suite. Validate changes via TestForm scenarios and harnesses under Source/Testing/TestHarnesses
  • When fixing a bug, add/adjust a minimal repro in TestForm or a harness and describe manual steps in the PR

Commit & Pull Request Guidelines

  • Commits: short, imperative subject; reference issues/PRs (e.g., Fix autosizing (#2433) or 2439 V110 datecell autosizing)
  • PRs: clear description, linked issues, screenshots/gifs for UI changes, notes on breaking changes/TFM impact

Security & Configuration Tips

  • Windows long paths must be enabled to build locally (see README link). Build on Windows for -windows TFMs