Skip to content

Note the metadata convention for generated binaries #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dabeckham merged 1 commit into from
Jul 26, 2026
Merged

Note the metadata convention for generated binaries #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,13 @@ green before merge.
are gitignored; document new settings with safe placeholders in `.env.example`.
- **Update the docs with the code.** A change that adds a route, a setting, or an
operational step updates the matching document under `docs/`.
- **Strip metadata from generated binaries before committing them.** Anything
produced by a tool — a PDF rendered from HTML, an exported image — carries an
embedded record of the machine that made it: source filename, the rendering
engine and its version, the operating system, a timestamp. None of it is
visible in the document and none of it belongs in a public repository.
`exiftool -all= file.pdf` clears it, or `qpdf` if you prefer to keep the
document structure untouched.
- Match the surrounding code's style; keep functions small and the modules'
single responsibilities intact (see [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)).

Expand Down
Loading