agentleFS
dimitar-radenkovdimitar-radenkov/Pointframe/.github/copilot-instructions.md

Pointframe

Copilot instructions15 starsChanged 24 days agoMITView on GitHub

Pointframe is a Windows-only WPF screen-capture, annotation, and recording application built on .NET 10. It uses CommunityToolkit.Mvvm, dependency injection, Serilog, and xUnit. The product name, solution, project files, namespaces, and top-level folders are Pointframe.

  • Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.

    Of the Copilot instructions files we read, the 2,343 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository13 other files it gives its agents.

The file

We split this copilot-instructions.md into the rules it gives an agent

12 rules. About 0 are common, 4 are distinctive, and 8 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 8

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Before architectural or cross-subsystem work, read docs/knowledge-base/knowledge-base.md, using its contents list to load only relevant …

    line 18
  2. Very specific:

    Before changing UI flow or window lifecycle code (overlay, dialog, hotkey, capture, tray, recording, DPI, multi-monitor), read lessons.md …

    line 19
  3. Very specific:

    Before finishing a change under Pointframe/ or Pointframe.Data/, decide whether the knowledge base needs an add, an update, or nothing.

    line 20
  4. Very specific:

    Use the knowledge-base skill when documenting architecture, subsystems, decisions, invariants, recurring how-tos, or durable references.

    line 21
  5. Very specific:

    Use MVVM: ViewModels inherit ObservableObject.

    line 27
  6. Very specific:

    Every public service has an I<Name> interface, is registered through DI, and is constructor-injected.

    line 28
  7. Distinctive:

    Follow the knowledge base for cross-cutting invariants, especially committed-only annotation undo groups, point-of-use settings reads, …

    line 30
  8. Very specific:

    Use Allman braces, file-scoped namespaces, nullable reference types, _camelCase private fields, and PascalCase public symbols.

    line 31
  9. Distinctive:

    Add focused xUnit tests alongside changed behavior.

    line 36
  10. Very specific:

    Run dotnet format Pointframe/Pointframe.csproj after every C# edit.

    line 37
  11. Distinctive:

    Run the narrowest applicable tests, then broaden validation when shared contracts, DI registration, or user-visible workflows change.

    line 38
  12. Distinctive:

    Never commit or push. Prepare the changes and validation results for user review.

    line 39

≈ “Common” is an estimate: at least 1 in 5 of the 3,779 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
copilot-instructions.md

Pointframe Copilot Instructions

Pointframe is a Windows-only WPF screen-capture, annotation, and recording application built on .NET 10. It uses CommunityToolkit.Mvvm, dependency injection, Serilog, and xUnit. The product name, solution, project files, namespaces, and top-level folders are Pointframe.

Commands

dotnet build Pointframe/Pointframe.csproj
dotnet run --project Pointframe/Pointframe.csproj
dotnet test Pointframe.Tests/Pointframe.Tests.csproj
dotnet test Pointframe.Tests/Pointframe.Tests.csproj --filter "FullyQualifiedName~<TestClass>"
dotnet format Pointframe/Pointframe.csproj
dotnet format Pointframe/Pointframe.csproj --verify-no-changes

Required Reading And Documentation

  • Before architectural or cross-subsystem work, read docs/knowledge-base/knowledge-base.md, using its contents list to load only relevant sections; for one feature area, read only docs/knowledge-base/features/<area>.md.
  • Before changing UI flow or window lifecycle code (overlay, dialog, hotkey, capture, tray, recording, DPI, multi-monitor), read lessons.md first.
  • Before finishing a change under Pointframe/ or Pointframe.Data/, decide whether the knowledge base needs an add, an update, or nothing. State that decision in the final response.
  • Use the knowledge-base skill when documenting architecture, subsystems, decisions, invariants, recurring how-tos, or durable references; use it after a completed feature, refactor, or fix when those facts changed.
  • Record a reusable bug, edge case, or implementation trap in lessons.md with its problem, root cause, fix, and takeaway. Keep it durable and concise rather than a task journal.

Architecture And Conventions

  • App.xaml.cs owns startup and shutdown. Register app services and windows in AppServiceRegistration.cs (AddPointframeAppServices); add OverlayWindow dependencies through its CreateOverlayWindow factory.
  • Use MVVM: ViewModels inherit ObservableObject; use [ObservableProperty] and [RelayCommand] rather than manually raising PropertyChanged.
  • Every public service has an I<Name> interface, is registered through DI, and is constructor-injected. Use singleton for long-lived state or OS handles, transient for per-operation objects, ViewModels, and windows, and scoped only for EF Core data services.
  • Window code-behind is limited to view-specific layout, HWND interop, DPI, and focus. Put application state and commands in ViewModels and OS, I/O, network, or process access behind services.
  • Follow the knowledge base for cross-cutting invariants, especially committed-only annotation undo groups, point-of-use settings reads, per-monitor DIP/pixel conversion, recording geometry, and installer publishing.
  • Use Allman braces, file-scoped namespaces, nullable reference types, _camelCase private fields, and PascalCase public symbols. Do not add XML documentation comments.
  • UserSettings is mutable. A setting added to UserSettings also needs Settings ViewModel persistence and its UI binding; consumers read IUserSettingsService.Current at the point of use rather than caching values.

Testing And Validation

  • Add focused xUnit tests alongside changed behavior. Test ViewModels and services directly with Moq; unit tests do not start WPF.
  • Run dotnet format Pointframe/Pointframe.csproj after every C# edit. Before review or CI readiness, also run dotnet format Pointframe/Pointframe.csproj --verify-no-changes.
  • Run the narrowest applicable tests, then broaden validation when shared contracts, DI registration, or user-visible workflows change.
  • Never commit or push. Prepare the changes and validation results for user review.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.