[fametrano]

Sourcery reads each Python file a pull request touches whole, so a pull request can fail its sourcery check on a line already on main, as PR #474 did on ecc/ellswift.py; no local gate runs Sourcery, so that shows only in CI. This adds a paragraph to CONTRIBUTING.md, next to its note on sourcery.yml, as the maintainer chose on the issue: touching a Python file makes the pull request responsible for Sourcery's findings anywhere in it, each fixed or skipped, and a writer who cannot run Sourcery reads each file the check reads whole.

Which files the check reads, the whole tree included where .sourcery.yaml or the version changes, and the form and place of a skip, stay in the standard's The set, and its cadence, which the paragraph points to.

Evidence

What	Result
uv sync --locked on f1bcd15	exit 0
uv run pytest -n 3 on f1bcd15	exit 0, 15719 passed, 177 skipped
uv run pre-commit run --all-files on f1bcd15	exit 0
sphinx-build -n -W, the href grep and check_included_links.py on f1bcd15	exit 0
Rebase	none: parent is origin/main 1a81844
Local review	dedicated reviewer: CHANGES REQUESTED on f8c8b60 (two facts of the standard stated again; the whole-tree case left out), then CLEARED f1bcd15
Fresh review in the other client	missing: codex exec refused at 2026-11-07 18:24 UTC with ERROR: Your workspace is out of credits. Add credits to continue. The dedicated reviewer's CLEARED ends the rounds.

The pointer's target, read at btclib-org/.github 42b087a3: README.md lines 2196-2210 state that the check "reads the Python files the pull request changes, whole, and the whole tree where it changes .sourcery.yaml or the version", and give the skip's form.

🤖 Generated with Claude Code

Closes #476

[coderabbitai]

No actionable comments were generated in the recent review.

Summary

Summary by CodeRabbit

• Documentation
  • Clarified contributor guidance for addressing Sourcery findings in Python files, including when Sourcery cannot be run locally.

CONTRIBUTING.md now explains how contributors must handle Sourcery findings across touched Python files, including when they cannot run Sourcery locally.

Changes: Sourcery contribution guidance

Layer / File(s)	Summary
Sourcery review instructions CONTRIBUTING.md	The guide says to address or skip Sourcery findings throughout each touched Python file. Contributors who cannot run Sourcery locally should review each checked file in full against .sourcery.yaml.

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other · Severity of issue fixed: Low

Possibly related PRs

• btclib-org/ecc#455: Adds the Sourcery pull-request check, configuration, and scoped-skip enforcement.

Merge Risk: Minimal · up to f1bcd

The contributor guidance is ready to merge with normal checks.

Architecture risk: Low · up to f1bcd

The change affects 1 system.

Changed systems: CONTRIBUTING.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

• observed — CONTRIBUTING.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

• observed — Modified behavior in CONTRIBUTING.md: Adds Sourcery guidance: Python-file changes cover findings throughout each affected file; findings are fixed or skipped under the referenced rules, and contributors who cannot run Sourcery locally read checked files in full against .sourcery.yaml.

Pre-merge checks: 4

Check name	Status	Explanation
Title check		The title describes the Sourcery guidance and names the issue in the required format. (raw.githubusercontent.com)
Description check		The description accurately describes the CONTRIBUTING.md change.
Linked Issues check		[#476] CONTRIBUTING.md makes the pull request responsible for Sourcery findings throughout touched Python files and tells writers without Sourcery to read each checked file in full. It directs contrib…
Out of Scope Changes check		[#476] The reported change adds Sourcery guidance to CONTRIBUTING.md. This documentation supports the issue.

Full details: Linked Issues check

Explanation

[#476] CONTRIBUTING.md makes the pull request responsible for Sourcery findings throughout touched Python files and tells writers without Sourcery to read each checked file in full. It directs contributors to the standard for the skip form and placement.

Finishing Touches

Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Usage-based review receipt

• Mode: Continue automatically
• Reviewed files: 1
• Waived: $0.25 (charged $0.00)
• View usage details

Note

This review exceeded your plan’s limits and used usage-based reviews—free during trial, billed after paid activation unless disabled. Manage usage-based reviews.

Recent review info

Run configuration

• Source mode: Auto
• Repository: btclib-org/ecc
• Branch: iss-476-sourcery-touched-files
• File: .coderabbit.yaml
• Commit: f1bcd15
• Layers: Repository YAML
• Review profile: ASSERTIVE
• Plan: Advanced
• Run ID: c74a746f-c9d8-4c74-9072-111ca1d83753

Commits

Reviewing files that changed from the base of the PR and between 1a81844 and f1bcd15.

Files selected for processing: 1

• CONTRIBUTING.md

Limit details: You’ve used all 10 included reviews currently available.

[read-the-docs-community]

Documentation build overview

📚 ecc | 🛠️ Build #35722730 | 📁 Comparing f1bcd15 against latest (1a81844)

  🔍 Preview build  

1 file changed

± contributing_link.html

[claude]

ACK f1bcd15