Files
james.maesandCodex GPT-6 38dd5c1488 feat: implement Windows MarkdownViewr (#35)
This replaces the blocked history in PR #3 with one properly attributed,
signed/DCO commit. The owner personally reviewed and approved PR #3 in
the release session.

**No file changes from the approved candidate:** both
baee14f492 and
e605df62c4 have exact Git tree
a85912cbad. Original PR #3 and its commits
are preserved for review history. Historical commits were locally signed
but GitHub reported no_user; protected merge checks those introduced
commits even for squash merging. This commit resolves attribution
without bypassing or weakening signature rules.

The reader, Settings, themes, source highlighting/split, live reload,
file associations, Print/PDF, About credits, toolbar/footer/editor
fixes, user-first README/screenshots and developer guides are exactly
the approved implementation. Stable/dev separation and protected Azure
signing caller are unchanged.

Evidence:
- Approved tree baee14f / CI38285775463 passes all checks. Downloaded
focused29/29, published111/111, stable110/110 and dev110/110 TRXs have
zero failures/skips. Core coverage100% lines/98.86% branches; actual
update/restart/coexistence/default-preservation receipts verify.
- New single-commit hooks, online workflow security, signing and DCO
pass. GitHub must rerun all required checks on this commit; results are
not copied across SHAs.
- Live repository setup validates18 Actions-bound checks, with only
fuzzing added and all prior protections preserved.
- OpenSSF project15417 is now owner-reviewed and saved at70% under
owner-confirmed CDLA-Permissive2.0. This is an in-progress assessment,
not a passing badge.
- Production CI OIDC and signed1.0/dev publication remain required;
local representative signing is not CI proof.

Substantial AI assistance: Codex (GPT-6). Supersedes PR #3. Release work
remains tracked in #33.

Closes #4, #6, #7, #8, #9, #10, #11, #12, #13, #14, #15, #16, #17, #18,
#19, #20, #21, #22, #23, #24, #25, #26, #27, #28, #29, #32, #34.
Refs #1, #5, #30, #31, #33.

Signed-off-by: James Maes <james@kof22.com>
Co-authored-by: Codex GPT-6 <noreply@openai.com>
2026-10-12 14:01:42 -05:00

2.6 KiB

Repository Guidelines

Purpose and Structure

MarkdownViewr.Windows is a Windows Markdown viewer built with AppKit and WinUI 3. Read docs/PRODUCT.md, docs/TODO.md and docs/SESSION-STATE.md before continuing. The first reader is implemented; full parity and desktop acceptance remain pending. Do not claim requirements passed without evidence.

src/MarkdownViewr.Windows.Core/ contains testable logic and view models. src/MarkdownViewr.Windows/ contains WinUI views and Windows adapters; brand assets are in Assets/Brand/. Unit, desktop UI and installed-update probes live under tests/. build/ contains coverage, packaging, setup and release validation tools.

Build and Test

Use Windows and the .NET 10 SDK selected by global.json:

dotnet restore MarkdownViewr.Windows.slnx -p:Platform=x64 --locked-mode
dotnet build MarkdownViewr.Windows.slnx -p:Platform=x64 -warnaserror
dotnet test tests/MarkdownViewr.Windows.Core.Tests --settings coverage.runsettings --collect:'XPlat Code Coverage' --results-directory TestResults
./build/Assert-Coverage.ps1 -ResultsDirectory TestResults
dotnet format MarkdownViewr.Windows.slnx --verify-no-changes --severity warn --no-restore

Desktop tests require an explicitly available interactive desktop. Run dotnet test tests/MarkdownViewr.Windows.UiTests only when input will not interfere with other work. Preserve 100% measured core coverage; use xUnit and deterministic injected time/filesystem boundaries. Follow Method_Scenario_Expectation test names.

Style and Contributions

Follow .editorconfig: three-space C# indentation, Allman braces, file-scoped namespaces, PascalCase public members and _camelCase private fields. Keep type/method comments and three blank lines between members. YAML uses two spaces. Centralize versions in Directory.Packages.props and commit regenerated locks.

Use topic branches, Conventional Commits, signed/DCO commits (git commit -S -s), and PRs targeting main. Report actual validation, link issues, include UI screenshots and disclose substantial AI assistance. Install both pre-commit and commit-msg hooks. Never fabricate the required human review acknowledgement.

Security and Continuity

Treat document content and renderer messages as untrusted; keep native access narrow. Preserve the original MIT notices when adapting Darin's code. Update the threat model for renderer/file-handling changes and maintain the session/task documents. Never commit secrets or publish unsigned production releases. Follow the repository release runbooks and existing authorization boundaries.