Skip to content

Consolidate MiniPdf contribution guidance - #162

Merged
shps951023 merged 1 commit into
mainfrom
docs/consolidate-contribution-guidance
Sep 9, 2026
Merged

Consolidate MiniPdf contribution guidance#162
shps951023 merged 1 commit into
mainfrom
docs/consolidate-contribution-guidance

Conversation

@shps951023

@shps951023 shps951023 commented Sep 8, 2026

Copy link
Copy Markdown
Member

Summary

  • consolidate the rendering contribution workflow into .claude/skills/minipdf-contribution/SKILL.md
  • remove obsolete agent-specific commands, skills, and orchestration scripts
  • simplify contributor guidance and synchronize the quick-start prompt across translated READMEs
  • refresh the generated DOCX benchmark comparison report

Validation

  • git diff --cached --check
  • validated skill frontmatter, LibreOffice prerequisites, and ASCII-only content
  • verified the AGENTS skill target exists and README prompts are synchronized
  • verified no stale contribution-workflow references remain

Summary by CodeRabbit

  • Documentation

    • Simplified quick-contribution instructions across the main and translated README files to reference the MiniPdf contribution skill.
    • Reorganized contributor and agent guidance around concise, quality-focused practices.
  • Removed Capabilities

    • Removed the previous automated MiniPdf contribution workflow, including benchmark selection, validation, environment checks, and pull-request preparation guidance.
    • Removed the release-automation and README-translation skill documentation.

Copilot AI lite review requested due to automatic review settings September 8, 2026 16:15

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The updated tracked benchmark report includes a future/ambiguous “Generated” timestamp (missing timezone) and AGENTS.md has a minor heading-structure issue that should be corrected before merging.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR consolidates contributor guidance for MiniPdf rendering/visual-benchmark improvements into a single skill document, removes legacy agent-specific orchestration assets, and refreshes the tracked DOCX benchmark comparison report to match the current LibreOffice reference output.

Changes:

  • Move/centralize the contribution workflow guidance into .claude/skills/minipdf-contribution/SKILL.md and point AGENTS.md at it.
  • Remove obsolete agent skills/commands and the PowerShell “contribution loop” orchestration scripts under .github/skills/ (and the wrapper under scripts/).
  • Synchronize the “Quick contribution” prompt across README translations and update the tracked DOCX comparison report content/labels.
File summaries
File Description
tests/MiniPdf.Benchmark/reports_docx/comparison_report.md Refresh tracked DOCX benchmark comparison report content/labels and scores.
scripts/Invoke-MiniPdfContributionLoop.ps1 Remove legacy wrapper script for the old contribution-loop controller.
README.md Replace quick-start agent prompt with the consolidated skill invocation.
documents/README.zh-TW.md Sync quick-start prompt with English README.
documents/README.zh-CN.md Sync quick-start prompt with English README.
documents/README.ko.md Sync quick-start prompt with English README.
documents/README.ja.md Sync quick-start prompt with English README.
documents/README.it.md Sync quick-start prompt with English README.
documents/README.fr.md Sync quick-start prompt with English README.
CONTRIBUTING.md Remove the now-obsolete automated rendering improvement section that referenced the retired loop tooling.
AGENTS.md Point contributors to the consolidated .claude/skills/minipdf-contribution/SKILL.md guidance and simplify agent guidelines.
.github/skills/sync-readme-translations/SKILL.md Remove the old README translation sync skill.
.github/skills/skill-minipdf-contribution/SKILL.md Remove the legacy Copilot-specific contribution skill.
.github/skills/skill-minipdf-contribution/scripts/select-candidates.ps1 Remove legacy contribution-loop selector script.
.github/skills/skill-minipdf-contribution/scripts/resolve-implementation.ps1 Remove legacy implementation resolver.
.github/skills/skill-minipdf-contribution/scripts/preflight.ps1 Remove legacy preflight checks script.
.github/skills/skill-minipdf-contribution/scripts/contribution-loop.ps1 Remove legacy contribution-loop controller.
.github/skills/skill-minipdf-contribution/assets/pull-request-template.md Remove legacy PR template associated with the retired loop.
.github/skills/create-release/SKILL.md Remove legacy release skill document.
.cursor/commands/minipdf-contribution.md Remove legacy Cursor command wrapper for the retired loop.
.claude/skills/minipdf-contribution/SKILL.md Add the consolidated, vendor-neutral contribution guidance skill document.
.claude/commands/minipdf-contribution.md Remove legacy Claude command wrapper for the retired loop.
.agents/skills/minipdf-contribution/SKILL.md Remove legacy agents skill document for the retired loop.
Review details
  • Files reviewed: 22/23 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread AGENTS.md
# Agent Instructions

For MiniPdf rendering or visual benchmark contributions, read and follow `.claude/skills/minipdf-contribution/SKILL.md`.
# Agent Guidelines
@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 87e077be-b710-4b5c-ac41-b22d29f2d888

📥 Commits

Reviewing files that changed from the base of the PR and between 86b231a and b8a2d50.

📒 Files selected for processing (23)
  • .agents/skills/minipdf-contribution/SKILL.md
  • .claude/commands/minipdf-contribution.md
  • .claude/skills/minipdf-contribution/SKILL.md
  • .cursor/commands/minipdf-contribution.md
  • .github/skills/create-release/SKILL.md
  • .github/skills/skill-minipdf-contribution/SKILL.md
  • .github/skills/skill-minipdf-contribution/assets/pull-request-template.md
  • .github/skills/skill-minipdf-contribution/scripts/contribution-loop.ps1
  • .github/skills/skill-minipdf-contribution/scripts/preflight.ps1
  • .github/skills/skill-minipdf-contribution/scripts/resolve-implementation.ps1
  • .github/skills/skill-minipdf-contribution/scripts/select-candidates.ps1
  • .github/skills/sync-readme-translations/SKILL.md
  • AGENTS.md
  • CONTRIBUTING.md
  • README.md
  • documents/README.fr.md
  • documents/README.it.md
  • documents/README.ja.md
  • documents/README.ko.md
  • documents/README.zh-CN.md
  • documents/README.zh-TW.md
  • scripts/Invoke-MiniPdfContributionLoop.ps1
  • tests/MiniPdf.Benchmark/reports_docx/comparison_report.md
💤 Files with no reviewable changes (12)
  • .github/skills/skill-minipdf-contribution/assets/pull-request-template.md
  • .claude/commands/minipdf-contribution.md
  • .github/skills/skill-minipdf-contribution/scripts/select-candidates.ps1
  • .github/skills/create-release/SKILL.md
  • .github/skills/skill-minipdf-contribution/scripts/resolve-implementation.ps1
  • .github/skills/skill-minipdf-contribution/SKILL.md
  • scripts/Invoke-MiniPdfContributionLoop.ps1
  • .github/skills/skill-minipdf-contribution/scripts/preflight.ps1
  • .cursor/commands/minipdf-contribution.md
  • .github/skills/sync-readme-translations/SKILL.md
  • .agents/skills/minipdf-contribution/SKILL.md
  • .github/skills/skill-minipdf-contribution/scripts/contribution-loop.ps1

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The change removes legacy MiniPdf contribution commands, scripts, and workflow documentation. It adds a Claude Code skill with benchmark-based diagnosis and validation steps. Repository and translated README guidance now directs contributors to the new skill.

Changes

MiniPdf contribution workflow

Layer / File(s) Summary
New contribution skill
.claude/skills/minipdf-contribution/SKILL.md
Adds prerequisites, six implementation choices, benchmark case selection, root-cause diagnosis, focused testing, regression checks, and validation commands.
Repository guidance and workflow cleanup
AGENTS.md, CONTRIBUTING.md, .github/skills/*, .claude/commands/*, .cursor/commands/*, scripts/Invoke-MiniPdfContributionLoop.ps1
Replaces the previous agent and contribution-loop guidance. Removes legacy MiniPdf, release, translation, preflight, candidate-selection, and contribution-loop files.
Localized quick-contribution guidance
README.md, documents/README.*.md
Replaces detailed prompts with a direct instruction to run the minipdf-contribution skill.

Priority: ⬇️ Low — Defer this contribution-guidance consolidation because it changes documentation and agent workflow without direct runtime product impact.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to b8a2d

The consolidated contribution workflow is internally consistent, with no concrete merge-blocking risk identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the primary change: consolidating the MiniPdf contribution workflow and guidance into a centralized skill.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/consolidate-contribution-guidance

Comment @coderabbitai help to get the list of available commands.

@shps951023
shps951023 merged commit 71c44aa into main Sep 9, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants