Skip to content

Document diff summary check for contributors #390

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

Draft
MukundaKatta wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Document diff summary check for contributors #390

Show file tree
Hide file tree
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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 3 additions & 0 deletions tests/test_metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down