Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (36 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

52 lines (36 loc) · 2.16 KB
Raw

Contributing

Thanks for your interest in contributing to Pointframe.

The product is now branded as Pointframe, and the main solution, project files, namespaces, and top-level source folders use Pointframe.

Getting Started

Prerequisites: Windows 10/11, .NET 10 SDK, Visual Studio 2022 or VS Code.

git clone https://github.com/dimitar-radenkov/Pointframe.git
cd Pointframe
dotnet build Pointframe/Pointframe.csproj
dotnet test  Pointframe.Tests/Pointframe.Tests.csproj

Before You Submit

Run the formatter — CI will reject unformatted code:

dotnet format Pointframe/Pointframe.csproj

Key Conventions

  • MVVM: Use [ObservableProperty] and [RelayCommand] from CommunityToolkit.Mvvm. Never raise PropertyChanged manually.
  • DI: Every service must have an interface (IMyService). Register new services in App.xaml.cs → ConfigureServices().
  • Models: Shape data belongs in Models/ShapeParameters.cs as an immutable sealed record, never a mutable class.
  • Braces: Always use {} blocks for if/else/for/foreach — even single-line bodies.
  • Nullable: All reference-type fields and parameters must be non-nullable unless genuinely optional (use ?).
  • No XML doc comments (/// <summary>).

Adding a New Annotation Tool

  1. Add a value to the AnnotationTool enum in AnnotationTool.cs.
  2. Add a matching sealed record in Models/ShapeParameters.cs.
  3. Handle the new case in AnnotationViewModel.TryGetShapeParameters().
  4. Render it in AnnotationCanvasRenderer (UpdateDragFeedback + CommitShape).
  5. Add unit tests in Pointframe.Tests/ViewModels/AnnotationViewModelTests.cs.

Pull Request Tips

  • Keep PRs focused — one feature or fix per PR.
  • Add or update tests for any behaviour change.
  • Reference related issues with Fixes #123.
  • The CI pipeline runs build, tests, format check, and CodeQL on every PR — make sure it passes locally first.

Good First Issues

New to the codebase? Look for issues labelled good first issue.