Contributing to KissThePDF

KissThePDF is a community-driven open-source project licensed under MIT. We welcome contributions from developers, designers, technical writers, and security researchers!

Welcome Open Source Contributors

Whether you are fixing a typo, resolving a bug, building a new PDF processing tool, or improving accessibility, your help is appreciated.

Ways to Contribute

Code & Bug Fixes

Fix issues, optimize processing speed, or refactor components.

New PDF Tools

Implement one of the roadmap tools from our centralized registry.

Documentation

Expand user guides, write technical specifications, or correct typos.

UI & Accessibility

Improve ARIA labels, keyboard navigation, and responsive mobile layouts.

Step-by-Step Pull Request Guide

Contribution Workflow

# 1. Fork the repository on GitHub
# Visit: https://github.com/positiveabhii/kiss-the-pdf and click "Fork"

# 2. Clone your local fork
git clone https://github.com/YOUR_USERNAME/kiss-the-pdf.git
cd kiss-the-pdf

# 3. Add upstream remote
git remote add upstream https://github.com/positiveabhii/kiss-the-pdf.git

# 4. Create a descriptive feature branch
git checkout -b feature/add-watermark-tool

# 5. Install dependencies and make your changes
npm install

# 6. Test and lint your changes locally
npm run lint
npm run build

# 7. Commit your changes
git commit -m "feat(tools): implement local watermark overlay processing"

# 8. Push branch to your fork
git push origin feature/add-watermark-tool

# 9. Open a Pull Request on GitHub!

Adding a New PDF Tool

When contributing a new PDF tool to KissThePDF:

Register or update the tool in src/config/tools.ts with status: "implemented".
Create the application tool page component under src/app/[tool]/page.tsx.
Ensure all PDF manipulation logic is executed client-side via pdf-lib or background Web Workers.
Verify that no network request sends file data off the user's device.

Code Quality & PR Expectations

Ensure npm run build and npm run lint pass with 0 warnings.
Write descriptive commit messages explaining the rationale behind your changes.
Reference existing GitHub issues in your PR description.

Open Source Project

KissThePDF is 100% Free & Open Source

All code runs locally in your browser. Contribute code, report bugs, add new tools, or star the repository to support privacy-first software.

Star on GitHub Contribute