patchnote-pal

PatchNote Pal turns messy release notes / changelogs into clean, user-specific updates. Paste raw notes (or point it at a GitHub release), then generate tailored outputs for QA, Support, and End Users with a diff-highlighted summary, risk callouts, and ready-to-send formats (Markdown, Slack, Zendesk).

Monorepo setup

This repo is a pnpm workspace with:

• apps/web — Next.js UI
• packages/core — parsing + summarization logic (stubbed)
• packages/types — shared TypeScript types
• packages/config — shared eslint/prettier/tsconfig packages

Requirements

• Node.js >= 18
• pnpm >= 9

Getting started

pnpm install
pnpm dev

Then open http://localhost:3000

Scripts

From the repo root:

• pnpm dev — run the Next.js app
• pnpm build — build all packages + app
• pnpm test — run tests (Vitest)
• pnpm lint — run ESLint
• pnpm format — format via Prettier

Environment variables

• apps/web/.env.local is supported (Next.js default)
• Root .env is supported for local scripts/tests

Example:

cp .env.example .env

Notes

The @patchnote-pal/core package currently contains stubbed functions to establish structure and will be filled in with real parsing/summarization logic in subsequent issues.