Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
20 lines (16 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

20 lines (16 loc) · 1.35 KB
Raw

Contributing

Thanks for helping improve Doc Diff. Every change is judged by two questions: does it keep the comparison fast and clear, and does it preserve the strict zero-network, single-file privacy guarantee?

  • Open an issue first for anything larger than a bug fix so we can align on the approach before you write code.

  • Edit the sources (src/template.html, src/styles.css, src/js/*.js), then rebuild. Never hand-edit DocDiff.html, site/index.html or site/en/index.html directly; they are generated by python3 scripts/build.py.

  • Keep the privacy & standalone invariants intact:

    • Content-Security-Policy must keep connect-src 'none' and form-action 'none'.
    • Zero external CDN scripts, external stylesheets, or remote font URLs.
    • Zero persistence of user documents (localStorage, sessionStorage, indexedDB, or document.cookie are forbidden).

  • Every UI string exists in both German (de) and English (en). Update both dictionaries in src/js/01-i18n.js.

  • Everything on GitHub is in English: commits, pull requests, issues, docs, and release notes (see CLAUDE.md).

  • Run the build and verification checks before opening a pull request:

    python3 scripts/build.py
node scripts/check.mjs

By contributing, you agree that your contribution is licensed under the MIT License.