Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (65 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

89 lines (65 loc) · 3.49 KB
Raw

Guidelines for Contributing to Beutl

Thanks for your interest in contributing! This guide covers how to set up a local build, how to test and format your changes, and the conventions we follow.

Prerequisites

  • .NET SDK — version 10.0.100 or newer is pinned in global.json (rollForward: latestFeature). Install the matching SDK so the build resolves the same version CI uses.
  • Git with the ability to push a feature branch.
  • FFmpeg is not a build prerequisite: it runs as a separate Beutl.FFmpegWorker process reached over IPC, and is installed at runtime.

Beutl dual-targets net10.0 and net10.0-windows. Windows-only targets build on Windows; on Linux/macOS use -f net10.0 where a single framework is needed.

Build / Test / Format

dotnet build Beutl.slnx                                            # build
dotnet test Beutl.slnx -f net10.0 --settings coverlet.runsettings  # test
dotnet format Beutl.slnx                                           # format
./build.sh <Target>                                                # Nuke (same as CI)

dotnet format is enforced in CI (Format check), so run it before pushing.

Running / Debugging

The application entry point is the src/Beutl project. Run it with dotnet run --project src/Beutl (or set it as the startup project in your IDE).

Pull request

To avoid duplicating work that may already be in progress, it is recommended to open an issue before submitting a PR. If the changes are minor, you may not need to open an issue.

To keep the history clean, do not forget to rebase and force push.

The PR template asks for a description, affected areas, a test plan, and any breaking changes — please fill it in. A few rules CI and reviewers enforce:

  • New logic ships with a NUnit test under tests/ (e.g. tests/Beutl.UnitTests/, tests/SourceGeneratorTest/).
  • New XAML uses compiled bindings (x:CompileBindings="True" + x:DataType).
  • Do not cross the GPL/MIT boundary: MIT projects must not take a ProjectReference to Beutl.FFmpegWorker; reach it only via IPC.

Commit messages

We follow Conventional Commits:

  • fix: — bug fix
  • feat: — new feature
  • refactor: — behavior-preserving refactor
  • docs: — documentation

Breaking changes use a feat!: / refactor!: subject and a BREAKING CHANGE: footer describing the migration.

Code Guidelines

We use the .NET Coding Style.

UI Implementation

  • If the event handler of a UserControl becomes complex, separate it into a Behavior or split the file using partial.

XAML Files

  • Use four spaces for indentation.
  • When adding properties to a control, place the first property on the same line as the element, and align all subsequent properties on separate lines with the first property.
  • When using Binding, use compiled bindings.
<UserControl x:CompileBindings="True"
             x:DataType="viewModel:MyViewModel">
    <TextBox Foreground="White"
             MaxWidth="240"
             Text="{Binding Text.Value}" />
</UserControl>

Where things live

See the module boundary map and detailed contributor rules in AGENTS.md, and the AI-assisted workflow docs under docs/ai-workflow/.