Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (37 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 1.17 KB

Contributing

Thanks for contributing to SmartDocs.

Setup

cp .env.example .env
npm install
npm run db:up
npm run prisma:migrate -- --name init_templates
npm run prisma:generate
npm run editor

Development Rules

  • Keep template schema and renderer behavior aligned.
  • Add or update starter examples when you add new template features.
  • Prefer small, focused pull requests.
  • Include reproduction steps for bug fixes.

Where To Post

  • Discussions > Ideas: feature proposals and roadmap suggestions.
  • Discussions > Q&A: usage and implementation questions.
  • Issues: implementation-ready bugs and scoped feature work.

Before Opening a PR

Run:

npm run check
npx playwright install chromium
npm run golden:pdf

And if your change affects PDF output:

npm run render:pdf -- --template examples/enterprise-cover-template.json --data examples/enterprise-cover-data.json --out out/enterprise-cover-render.pdf

Pull Request Checklist

  • Change is scoped and documented
  • Schema updated (if needed)
  • Editor and renderer both updated (if needed)
  • Example template/data updated (if needed)
  • Commands in README still valid