From 60aa5ea62fad0f31771058f6c01e346790d149d6 Mon Sep 17 00:00:00 2001 From: mukunda katta Date: Mon, 11 May 2026 15:56:03 -0700 Subject: [PATCH] Document diff summary check for contributors --- README.md | 3 ++- tests/test_metadata.py | 3 +++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eb204b88..3d20ccb2 100644 --- a/README.md +++ b/README.md @@ -602,7 +602,8 @@ For concise contributor expectations and a welcoming baseline, read To choose the right bug, feature, integration, or cloud/team template, use the [issue template chooser](https://github.com/aaronlab/browsertrace/issues/new/choose). Before opening a PR, use the [pull request template](.github/PULL_REQUEST_TEMPLATE.md) -and include a linked issue and test commands. +and include a linked issue and test commands; check `git diff --stat` and +`git diff --summary` for unexpected deleted or renamed files. For security-sensitive reports or private trace data, follow [SECURITY.md](SECURITY.md) before sharing details publicly. diff --git a/tests/test_metadata.py b/tests/test_metadata.py index 895dc79c..aeff638b 100644 --- a/tests/test_metadata.py +++ b/tests/test_metadata.py @@ -1356,6 +1356,9 @@ def test_readme_links_pull_request_template_near_contributing(): in contributing_section ) assert "linked issue and test commands" in contributing_section + assert "git diff --stat" in contributing_section + assert "git diff --summary" in contributing_section + assert "unexpected deleted or renamed files" in contributing_section assert 'pip install "browsertrace[ui]"' in readme assert "hosted sharing" not in readme