Contributing

Thanks for helping improve Unpress.

Development setup

Clone the repo and install dependencies:

git clone https://github.com/selfagency/unpress.git
cd unpress
pnpm install

Build the package locally:

pnpm build

Run the local CLI during development:

pnpm dev:cli -- --help

Testing

Run the full test suite:

pnpm test

Run coverage:

pnpm test:coverage

Run a specific test file:

pnpm test -- tests/e2e-xml-media.test.ts

Linting and formatting

Run code linting:

pnpm lint

Run Markdown linting:

pnpm lint:md

Format the repo:

pnpm format
pnpm lint:md:fix

Documentation work

Preview docs locally:

pnpm docs:dev

Build docs:

pnpm docs:build

Environment and fixtures

The published tool is designed to read .env automatically. The codebase also uses .env during local CLI testing, so create a local .env when you need real credentials.

Never commit real secrets. Use placeholder values in examples and docs.

Pull requests

Keep changes focused.

• update docs when behavior changes
• add or adjust tests for behavior changes
• avoid unrelated refactors in the same PR
• explain the user-facing impact in the PR description

Reporting issues

When filing a bug, include:

• how you ran Unpress (pnpx, npx, or local pnpm dev:cli)
• whether you used API or XML input
• whether a .env file was present
• the command you ran
• the relevant error output

That saves everyone time, including future-you.