Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 10 additions & 20 deletions .claude/skills/minipdf-contribution/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: minipdf-contribution
description: "Guide a first-time MiniPdf contributor through choosing an implementation language, selecting a failing visual benchmark case, making a focused rendering fix, and validating the complete benchmark. Use when contributing rendering improvements to MiniPdf in .NET, Rust, Java, Go, Python, or Node.js."
description: "Guide a first-time MiniPdf contributor through selecting a failing .NET visual benchmark case, making a focused rendering fix, and validating the complete benchmark. Use when contributing rendering improvements to MiniPdf in .NET."
compatibility: "Designed for Claude Code, Codex, and GitHub Copilot. Requires Git, PowerShell, the selected language toolchain, Python benchmark dependencies, an installed LibreOffice executable, and a LibreOffice core source checkout."
---

Expand All @@ -21,20 +21,15 @@ If the source checkout is missing, tell the user it is required for renderer-beh

If the LibreOffice executable is missing, explain that cloning the source does not install LibreOffice and ask the user how they want to install or provide the executable. Do not run visual benchmarks until both the executable and source checkout are available.

## 2. Choose an Implementation
## 2. Use the .NET Implementation

Ask which implementation language the user wants to improve and wait for an explicit answer:
This repository contains only .NET. For other implementations, use their independent PdfLibrarys repositories:

| Choice | Repository path | Benchmark command |
|---|---|---|
| .NET | `src/` | `scripts/Run-DotNet-VisualBenchmark.ps1` |
| Rust | `minipdf-rs/` | `scripts/Run-Rust-VisualBenchmark.ps1` |
| Java | `minipdf-java/` | `scripts/Run-Java-VisualBenchmark.ps1` |
| Go | `minipdf-go/` | `scripts/Run-Go-VisualBenchmark.ps1` |
| Python | `minipdf-python/` | `scripts/Run-Python-VisualBenchmark.ps1` |
| Node.js | `minipdf-node/` | `scripts/Run-Node-VisualBenchmark.ps1` |

Do not choose a language on the user's behalf.
Use the .NET source and benchmark commands below.

## 3. Select a Failing Case

Expand All @@ -44,10 +39,10 @@ Find the available reports for the selected language under:
artifacts/<language>-benchmark/<suite>/<format>/report/comparison_report.md
```

`<language>` is `dotnet`, `rust`, `java`, `go`, `python`, or `node`; `<suite>` is `classic` or `issue`; and `<format>` is `xlsx`, `docx`, or `pptx`. For example:
`<language>` is `dotnet`; `<suite>` is `classic` or `issue`; and `<format>` is `xlsx`, `docx`, or `pptx`. For example:

```text
artifacts/java-benchmark/issue/xlsx/report/comparison_report.md
artifacts/dotnet-benchmark/issue/xlsx/report/comparison_report.md
```

Inspect the report data and select one valid case whose overall score is below `0.95`. Prefer the lowest reproducible score across the available reports for that language. Exclude missing or invalid candidate/reference PDFs. If no current report exists for a suite and format, generate it with the corresponding full benchmark command before selecting a case.
Expand All @@ -74,29 +69,24 @@ Compare the complete final report with the preserved baseline. Reject or revise

Run the selected implementation's relevant unit tests and `git diff --check` after the full benchmark. Report the exact commands, before-and-after scores, page counts, image paths, and any remaining risk.

## Cross-Language Visual Benchmarks
## .NET Visual Benchmarks

Use the following form for .NET, Rust, Java, Go, Python, and Node:
Use the following form for .NET:

```powershell
scripts/Run-<Language>-VisualBenchmark.ps1 -Suite <classic|issue> -Format <xlsx|docx|pptx> -MaxCases <n>
scripts/Run-DotNet-VisualBenchmark.ps1 -Suite <classic|issue> -Format <xlsx|docx|pptx> -MaxCases <n>
```

Supported commands:

```powershell
scripts/Run-DotNet-VisualBenchmark.ps1 -Suite <classic|issue> -Format <xlsx|docx|pptx> -MaxCases <n>
scripts/Run-Rust-VisualBenchmark.ps1 -Suite <classic|issue> -Format <xlsx|docx|pptx> -MaxCases <n>
scripts/Run-Java-VisualBenchmark.ps1 -Suite <classic|issue> -Format <xlsx|docx|pptx> -MaxCases <n>
scripts/Run-Go-VisualBenchmark.ps1 -Suite <classic|issue> -Format <xlsx|docx|pptx> -MaxCases <n>
scripts/Run-Python-VisualBenchmark.ps1 -Suite <classic|issue> -Format <xlsx|docx|pptx> -MaxCases <n>
scripts/Run-Node-VisualBenchmark.ps1 -Suite <classic|issue> -Format <xlsx|docx|pptx> -MaxCases <n>
```

During diagnosis, add `-Filter "<case-name>"` for a focused run. For final validation, omit both `-Filter` and `-MaxCases`:

```powershell
scripts/Run-<Language>-VisualBenchmark.ps1 -Suite <classic|issue> -Format <xlsx|docx|pptx>
scripts/Run-DotNet-VisualBenchmark.ps1 -Suite <classic|issue> -Format <xlsx|docx|pptx>
```

Use only suite and format combinations supported by the benchmark runner. Keep generated PDFs, images, heatmaps, and full logs under `artifacts/`; summarize results in chat instead of embedding image data or complete reports.
2 changes: 0 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ body:
description: Which language implementation is affected?
options:
- .NET (C#)
- Rust
- Both / shared
validations:
required: true

Expand Down
2 changes: 0 additions & 2 deletions .github/ISSUE_TEMPLATE/conversion_quality.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ body:
description: Which language implementation is affected?
options:
- .NET (C#)
- Rust
- Both / shared
validations:
required: true

Expand Down
2 changes: 0 additions & 2 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ body:
description: Which language implementation does the documentation cover?
options:
- .NET (C#)
- Rust
- Both / shared
- Not applicable
validations:
required: true
Expand Down
2 changes: 0 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ body:
description: Which language implementation should this feature target?
options:
- .NET (C#)
- Rust
- Both / shared
validations:
required: true

Expand Down
2 changes: 0 additions & 2 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ body:
description: Which language implementation is your question about?
options:
- .NET (C#)
- Rust
- Both / shared
validations:
required: true

Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ scores or before-and-after images for rendering changes.

- [ ] The change is focused and does not include unrelated formatting or generated files.
- [ ] New or changed behavior has automated test coverage where practical.
- [ ] Relevant .NET and/or Rust checks pass.
- [ ] Relevant .NET checks pass.
- [ ] Public API and compatibility effects are documented.
- [ ] Security implications and untrusted-input behavior were considered.
- [ ] I have the right to submit every added source file, fixture, font, image, and other asset under its stated license.
Expand Down
81 changes: 0 additions & 81 deletions .github/workflows/crates-publish.yml

This file was deleted.

64 changes: 0 additions & 64 deletions .github/workflows/go-ci.yml

This file was deleted.

Loading
Loading