Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (29 loc) · 986 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (29 loc) · 986 Bytes

Contributing to PDFTranslator

Thank you for your interest in contributing! This document explains how to set up the project, propose changes, and follow our conventions so reviews go smoothly.

Table of Contents

Ways to Contribute

  • Fix bugs or improve error handling
  • Add features (e.g., real translation providers, output to PDF)
  • Improve documentation (README, examples, troubleshooting)
  • Write or expand unit tests

Project Setup

Requirements:

  • .NET 10 SDK
  • JetBrains Rider (or your preferred IDE)

Build & run:

dotnet build
dotnet run --project PDFTranslator.Cli -- -i "sample.pdf" -o "output.txt" -t "en" --provider dummy
dotnet test