Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
executable file
·
59 lines (40 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
59 lines (40 loc) · 1.65 KB
Raw

Contributing to Simple PDF

Thanks for contributing. Simple PDF is a self-hosted PDF merge / clean / edit / OCR tool (MIT).

Development setup

python3.12 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
cp .env.example .env
gunicorn -w 2 -b 127.0.0.1:8000 --timeout 600 wsgi:app

Docker:

cp .env.example .env
docker compose up --build
# http://localhost:8080

Optional system packages (OCR / office conversion): see docs/INSTALL.md or deploy/install-ocr-apt.sh and deploy/install-libreoffice.sh.

Guidelines

  • Prefer minimal, focused changes. Do not refactor unrelated code.
  • Do not break critical features listed in .cursorrules (stable SECRET_KEY, session-on-disk, upload validation, combine defaults, OCR hook).
  • Keep fixed versions in requirements.txt.
  • Never commit .env, .secret_key, tokens, or files under uploads/.
  • Public docs are in English; Spanish user docs live under docs/ (MANUAL_USUARIO.md).
  • UI i18n (when present): keep en / es in sync.

Before a PR

Smoke-test at least:

  1. Upload a PDF
  2. Combine with default options
  3. One editor action (e.g. rotate or crop)
  4. /api/health returns OK

Pull requests

  1. Describe why the change is needed.
  2. Note any env / deploy / UI impact.
  3. Keep PRs reviewable (prefer small scoped PRs).

Code of conduct

See CODE_OF_CONDUCT.md.

Security

Report vulnerabilities privately (see SECURITY.md). Do not open public issues with exploit details for unreleased flaws.

License

By contributing, you agree your contributions are licensed under the MIT License.