Problem
Notebook commits currently include execution outputs and transient metadata, which creates noisy diffs and frequent merge conflicts.
Proposal
Adopt nbstripout via pre-commit so .ipynb files are automatically stripped before commit.
Impact
- Cleaner PR diffs focused on meaningful notebook source changes
- Fewer notebook merge conflicts
- Smaller/cleaner git history over time
Scope / tasks
- Add/update
.pre-commit-config.yaml with an nbstripout hook for *.ipynb
- Add contributor setup docs (
pre-commit install, optional pre-commit run --all-files)
- (Optional) add CI enforcement so unstripped notebooks fail checks
- (Optional) run a one-time normalization pass on existing notebooks
Acceptance criteria
- Committed notebooks do not include cell outputs/transient metadata
- Setup steps are documented and reproducible
- (If CI added) PR checks fail when notebook outputs are present
Problem
Notebook commits currently include execution outputs and transient metadata, which creates noisy diffs and frequent merge conflicts.
Proposal
Adopt
nbstripoutviapre-commitso.ipynbfiles are automatically stripped before commit.Impact
Scope / tasks
.pre-commit-config.yamlwith annbstripouthook for*.ipynbpre-commit install, optionalpre-commit run --all-files)Acceptance criteria